Skip to content

Commit 55797f4

Browse files
authored
feat(AIP-8): add requirement for counterexamples (#1116)
should / should not guidance in the AIPs are vague, and leaves the exercise of determining whether the guidance should be ignored completely up to the reader. Adding clear examples will help clarify the scenarios where it makes sense to ignore the guidance.
1 parent 7a43e6f commit 55797f4

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

aip/general/0008.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,12 @@ described in [RFC 2119][].
210210
When using these terms in AIPs, they **must** be lower-case and **bold**. These
211211
terms **should not** be used in other ways.
212212

213-
**Important:** If an appendix is used, it exists to provide background and a
214-
more complete understanding, but **must not** contain guidance (and RFC-2119
215-
terms **must not** be used).
213+
If "SHOULD" or "SHOULD NOT" are used, they **must** include valid examples of
214+
where other concerns may override the guidance.
215+
216+
**Important:** If rationale is used, it exists to provide background and a more
217+
complete understanding, but **must not** contain guidance (and RFC-2119 terms
218+
**must not** be used).
216219

217220
### Code examples
218221

0 commit comments

Comments
 (0)