From 090f9f9c7075624c0f7371f1216124fc034ee2c7 Mon Sep 17 00:00:00 2001 From: Quincy Morgan Date: Wed, 9 Oct 2019 16:04:14 +0200 Subject: [PATCH] Fix typo and add note about unstable validation type IDs --- ARCHITECTURE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index c448abfd0..cefb8557e 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -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.