Skip to content

Commit

Permalink
docs(cod-conv): make linking to items mandatory when possible
Browse files Browse the repository at this point in the history
  • Loading branch information
ROMemories authored and kaspar030 committed Apr 22, 2024
1 parent 51b1109 commit 4623f02
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions book/src/coding-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ write:

More generally, use the [`std` docs](https://doc.rust-lang.org/stable/std/) as inspiration.

When possible—i.e., when items are in scope—items mentioned in the documentation MUST be linked to (see [C-LINK](https://rust-lang.github.io/api-guidelines/documentation.html#prose-contains-hyperlinks-to-relevant-things-c-link)).
This is useful for readers, to quickly access the mentioned item, but it also helps prevent the docs from lagging behind, as broken links are tested for in CI, making it easy to spot renamed or removed items.

## `unsafe` Code

When `unsafe` is used, a `SAFETY` comment MUST be added, in the style [supported by Clippy](https://rust-lang.github.io/rust-clippy/master/index.html#/undocumented_unsafe_blocks).
Expand Down

0 comments on commit 4623f02

Please sign in to comment.