Skip to content

Commit 61a1161

Browse files
committed
Merge rust-bitcoin#4897: docs: Add rustdocs link policy section
168cf28 docs: Add rustdocs link policy section (Tobin C. Harding) Pull request description: With comment rust-bitcoin#4859 (comment) we decided to favour links at the bottom of a docs section instead of inline. Document this policy. ACKs for top commit: apoelstra: ACK 168cf28; successfully ran local tests; though FWIW "favour" is British English, not American English Tree-SHA512: fed46e45ef8f617e71a563f374472f24bee7d424319e26770139606b47eb6aed8a46b6e765de46ac94ed9773ad5c20b1c71336a105e536b04c43169608150828
2 parents 57fcb33 + 168cf28 commit 61a1161

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/policy.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,18 @@ panics that could theoretically occur because of bugs in our code must not be do
295295
Example code within the rustdocs should compile and lint with `just lint` without any errors or
296296
warnings.
297297

298+
### Links
299+
300+
We favour links at the bottom of the docs section:
301+
302+
```rust
303+
/// it is a real Taproot script spend (and not some other kind of output contrived
304+
/// to have a Taproot-shaped witness). See [BIP-0341] in particular footnote 7, for
305+
/// more information.
306+
///
307+
/// [BIP-0341]: <https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki>
308+
```
309+
298310
## Derives
299311

300312
We try to use standard set of derives if it makes sense:

0 commit comments

Comments
 (0)