Skip to content

Commit 3e40ee4

Browse files
authored
Merge pull request #4382 from OAI/ralfhandl-style-guide-no-requirements
style guide: no requirements in "Examples" sections
2 parents b5ab378 + 4ffcb64 commit 3e40ee4

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

style-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The following additional rules should be followed but currently are not enforced
2121
9. Use [Oxford commas](https://en.wikipedia.org/wiki/Serial_comma), avoid [Shatner commas](https://www.latimes.com/archives/blogs/jacket-copy/story/2011-06-30/goodbye-oxford-comma-hello-shatner-comma).
2222
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
2323
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
24+
12. Do not use [RFC2119 key words (MUST, MAY, ...)](https://datatracker.ietf.org/doc/html/rfc2119) in "Examples" sections or when explaining examples, and state requirements only in sections that are clearly normative.
2425

2526
Plus some suggestions, rather than rules:
2627

0 commit comments

Comments
 (0)