Skip to content

Commit 168cf28

Browse files
committed
docs: Add rustdocs link policy section
With comment rust-bitcoin#4859 (comment) we decided to favour links at the bottom of a docs section instead of inline. Document this policy.
1 parent 4591878 commit 168cf28

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
@@ -226,6 +226,18 @@ panics that could theoretically occur because of bugs in our code must not be do
226226
Example code within the rustdocs should compile and lint with `just lint` without any errors or
227227
warnings.
228228

229+
### Links
230+
231+
We favour links at the bottom of the docs section:
232+
233+
```rust
234+
/// it is a real Taproot script spend (and not some other kind of output contrived
235+
/// to have a Taproot-shaped witness). See [BIP-0341] in particular footnote 7, for
236+
/// more information.
237+
///
238+
/// [BIP-0341]: <https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki>
239+
```
240+
229241
## Derives
230242

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

0 commit comments

Comments
 (0)