Skip to main content

VERSION_EXEMPT

Constant VERSION_EXEMPT 

const VERSION_EXEMPT: [(&str, &str); 1];
Expand description

Files allowed to name a version segment other than latest, with the reason.

A (path, reason) list rather than a comment, for the reason check-api-links keeps its UNCLAIMABLE that way: the version check is only worth having if every exception to it is stated, and the reason is printed on every green run so the exception cannot become invisible by being written down once.

One entry. docs/_build/test_macros.py asserts what the link resolver produces for each branch of D38’s rule, and both branches are versions — …/atune/dev/api/rust/… when nothing is released, …/atune/0.1/api/rust/… under a release — so a test of the resolver has to be able to write the URLs the resolver emits. Exactly the shape of docs/design/**’s exemption: the file whose job is to describe a rule cannot be bound by it.