Skip to content

Commit

Permalink
Link the appendix
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss committed Oct 12, 2024
1 parent 9ea5e0e commit d5c6fb1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ When assigning rules to new paragraphs, or when modifying rule names, use the fo

#### Test rule annotations

Tests in <https://github.com/rust-lang/rust> can be linked to rules in the reference. The rule will include a link to the tests, and there is also an appendix which tracks how the rules are currently linked.
Tests in <https://github.com/rust-lang/rust> can be linked to rules in the reference. The rule will include a link to the tests, and there is also an [appendix] which tracks how the rules are currently linked.

Tests in the `tests` directory can be annotated with the `//@ reference: x.y.z` header to link it to a rule. The header can be specified multiple times if a single file covers multiple rules.

Expand All @@ -111,6 +111,8 @@ Prefixed rule names should not be used in tests. That is, do not use something l

We are not expecting 100% coverage at any time. Although it would be nice, it is unrealistic due to the sequence things are developed, and resources available.

[appendix]: https://doc.rust-lang.org/nightly/reference/test-summary.html

### Standard library links

You should link to the standard library without specifying a URL in a fashion similar to [rustdoc intra-doc links][intra]. Some examples:
Expand Down

0 comments on commit d5c6fb1

Please sign in to comment.