Skip to main content

Module rules

Module rules 

Source
Expand description

bookspec’s rule identifiers and their catalogue.

Every rule of docs/spec/rules.md (B-1 to B-45) has one bookspec identifier, BS-<area>-<n>, allocated by Area and numbered in B-rule order within its area. bookspec/spec/rules-index.md is the table, and a test keeps the two in step. The rules from B-39 on are allocated in plan/served.md 8.0.3 but not yet stated; they carry an identifier and an area and no status, so a later unit fills them in without moving anyone else’s number.

Structs§

Rule
One rule of the specification.

Enums§

Area
One of bookspec’s areas: the subject a rule belongs to.
Status
The status of a rule, in bookspec’s vocabulary: what its statement rests on. docs/spec/rules.md’s “DECISION” is bookspec’s Status::Choice (plan/served.md P13 step 3): the specification names the options, and an engine declares its pick through crate::Claims.

Functions§

covered_rules
The rules an engine can claim today: those with at least one example. A rule with no example has no evidence, so an engine cannot claim it (plan/served.md P13 step 4 fills the rest in).
rule
The rule b (1 to 45).
rule_for_id
The rule id names, if the specification states it.
rule_for_refusal
The rule a refusal belongs to, by its reason in the examples’ words (bookspec/README.md).
rules
The catalogue: every rule, in B-rule order.