forked from Urban-Meteorology-Reading/SUEWS
-
Notifications
You must be signed in to change notification settings - Fork 10
Open
Labels
1-featureNew functionalityNew functionality2-doc:userUser guides, tutorialsUser guides, tutorials2-infra:data-modelPydantic data models & validationPydantic data models & validation3-P2Medium priorityMedium priority4-readyReady for workReady for work
Description
This issue proposes associating each rule in the validator documentation (currently a work in progress in PR #851) with a unique rule ID.
This rule ID will also be:
- documented in the detailed documentation
- referenced consistently in the validation report
This approach serves three main purposes:
- help users understand what is checked and what is not
- provide a clear way to look up additional information about a specific rule
- provide a clear and unambiguous reference when reporting bugs or issues
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
1-featureNew functionalityNew functionality2-doc:userUser guides, tutorialsUser guides, tutorials2-infra:data-modelPydantic data models & validationPydantic data models & validation3-P2Medium priorityMedium priority4-readyReady for workReady for work