Merge rust-bitcoin/rust-bitcoin#6973: units: Document the encoding feature
What the developer wrote
Authored by Andrew Poelstra
Merge rust-bitcoin/rust-bitcoin#6973: units: Document the encoding feature
f9f9d76d52ccf517042757e140be8cc88e32003c units: Document the encoding feature (Jamil Lambert, PhD)
Pull request description:
The crate docs list the optional features but omit `encoding`, which pulls in `bitcoin-consensus-encoding` and adds the encoder and decoder types.
Add it to the list.
ACKs for top commit:
Abeeujah:
ACK f9f9d76d52ccf517042757e140be8cc88e32003c
apoelstra:
ACK f9f9d76d52ccf517042757e140be8cc88e32003c; successfully ran local tests
Tree-SHA512: 72b211f7a772c8287172102e73e1527b534167c8fa7e0066cb3ff36345cdfd0fbb11b8c1c26fdab87ec5f039714e7710206e8b59629d0ee7637dccc9d3e03ed7
What changed, and why it matters
This commit is a documentation-only change. It adds a missing entry to the crate's feature list in the source-code documentation, describing the optional `encoding` feature. There is no code change, no behavior change, and no security impact.
No action required. This is a non-security documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds two lines to the module-level documentation in units/src/lib.rs. The new lines document the encoding feature, which enables bitcoin-consensus-encoding support. No executable code, dependency declarations, or feature flags were modified.
Changed components
units/src/lib.rs (documentation comments only)Inspect captured patch +2 / −0
### units/src/lib.rs
@@ -27,6 +27,8 @@
//! * `serde` - causes the crate to depend on `serde` and provide support for serializing and
//! deserializing its types.
//! * `arbitrary` - causes the crate to depend on `arbitrary` and implement the `Arbitrary` trait.
+//! * `encoding` - causes the crate to depend on `bitcoin-consensus-encoding` and provide consensus
+//! encoders and decoders for its types.
//!
//! # MSRV
//!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.