Fix typo and add note about unstable validation type IDs

This commit is contained in:
Quincy Morgan
2019-10-09 16:04:14 +02:00
parent 19cee51539
commit 090f9f9c70

View File

@@ -383,7 +383,7 @@ _Yellow._ Warnings are general issues that the user is free to ignore. They have
#### Validation Rules
A validation rule is an object that takes an entity and a graph and returns objects of type `validationIssue` representing problems found with that entity for that graph. Rules are listed under `modes/validations` and correspond directly to the toggleable Rules list under the Issues pane in iD's UI.
A validation rule is an object that takes an entity and a graph and returns objects of type `validationIssue` representing problems found with that entity for that graph. Rules are listed under `modules/validations` and correspond directly to the toggleable Rules list under the Issues pane in iD's UI.
Each `validationIssue` takes its rule's `type` and may include a `subtype` that further differentiates it.
@@ -509,6 +509,8 @@ These tags cannot be manually removed or altered by the user—for example, by d
The format is: `{warnings|resolved}:{type}:{subtype}={count}`
Note that specific `type` and `subtype` IDs could change or vary slightly in meaning between different versions of iD.
##### `warnings`
The `warnings` namespace indicates issues that were created and ignored by the user. These must all be issues of severity `warning` and not `error` since errors block upload altogether and thus cannot be ignored.