Skip to content

Commit

Permalink
feat(AIP-8): add requirement for counterexamples (#1116)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
toumorokoshi committed Aug 3, 2023
1 parent 7a43e6f commit 55797f4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions aip/general/0008.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,12 @@ described in [RFC 2119][].
When using these terms in AIPs, they **must** be lower-case and **bold**. These
terms **should not** be used in other ways.

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

**Important:** If rationale is used, it exists to provide background and a more
complete understanding, but **must not** contain guidance (and RFC-2119 terms
**must not** be used).

### Code examples

Expand Down

0 comments on commit 55797f4

Please sign in to comment.