What the developer wrote
Authored by Tobin C. Harding
docs: Rename address file
We have a pluralisation anomoly
- modules use singular (`address`, `key`)
- crates use plural (`addresses`, and maybe `keys`)
Lets use the crate name for the docs file since the document describes
the crate.
What changed, and why it matters
This commit only renames a documentation file from docs/address.md to docs/addresses.md and updates the matching link in the roadmap. No code, logic, or security behavior changed.
No action needed; the change is non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
Purely cosmetic documentation rename. The diff shows file deletion/addition with identical content and a single reference update in docs/roadmap.md. No Rust source, build scripts, tests, or configuration were modified.
Changed components
docs/address.mddocs/addresses.mddocs/roadmap.mdInspect captured patch +5 / −5
diff --git a/docs/address.md b/docs/address.md
deleted file mode 100644
index f55b5798..00000000
--- a/docs/address.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Split out an address crate
-
-Split the `address` module out into its own crate.
diff --git a/docs/addresses.md b/docs/addresses.md
new file mode 100644
index 00000000..f55b5798
--- /dev/null
+++ b/docs/addresses.md
@@ -0,0 +1,3 @@
+# Split out an address crate
+
+Split the `address` module out into its own crate.
diff --git a/docs/roadmap.md b/docs/roadmap.md
index 79ca0429..0e9b170d 100644
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -5,7 +5,7 @@
* Implement script tagging
* Add support for consensus encoding to `primitives`
* Release `bitcoin v0.33.0-rc.0`
-* Split out an address crate (see [address.md])
+* Split out an address crate (see [addresses.md])
* BIP-32 and BIP-380 (see [bip-32.md])
* PSBTv2 (see [psbt.md])
* Make it possible for `bitcoin` to depend on `miniscript` (see [#2882])
@@ -16,7 +16,7 @@
We want to do a long release candidate cycle to give time for downstream testing and feedback on the
API of the 1.0 crates. At a minimum this will be 6 months from the release `primitives-1.0-rc.0`.
-[address.md]: ./address.md
+[addresses.md]: ./addresses.md
[bip-32.md]: ./bip-32.md
[psbt.md]: ./psbt.md
[#2882]: <https://github.com/rust-bitcoin/rust-bitcoin/issues/2882>
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.