Replace uses of rfc2119 keywords in non-normative sections #340
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chcunningham
approved these changes
Aug 18, 2021
There was a problem hiding this comment.
LGTM % nits
I'm not sure yet if we want to capitalize the words, maybe we do. This is easily done in any case, because they only appear normatively now.
I'm happy to go ahead with capitalizing (now or later). Seems the style guide is to do this w/ an <em> and a bit of CSS.
https://www.w3.org/Guide/manual-of-style/#RFC
aboba
approved these changes
Aug 18, 2021
…agraphs
This was done mostly via this scripts:
> #!/usr/bin/env python
>
> # no optional and required because they are webidl keywords and don't
> # appear otherwise in the spec
> RFC_2119_LIST_LOWER=("must", "must not", "shall", "shall not", "should", "should not", "recommended", "may")
> RFC_2119_LIST_UPPER=("MUST", "MUST NOT", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY")
>
> fin = open("index.src.html", "rt")
> fout = open("index-replaced.src.html", "wt")
> for line in fin:
> replaced = line
> for i, word in enumerate(RFC_2119_LIST_LOWER):
> replaced = replaced.replace(RFC_2119_LIST_LOWER[i],
> "<em class=\"rfc2119\">" + RFC_2119_LIST_UPPER[i] + "</em>")
> fout.write(replaced)
> fin.close()
> fout.close()
and then rewrapped in vim.
|
I added the |
|
Looks good! |
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Aug 23, 2021
SHA: f25d932 Reason: push, by @chcunningham Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is split in multiple commits for ease of review, but the second commit has most of the actual changes.
There is a single occurrence that I thought was good to make normative (third commit). It's a MAY, so it's not a requirement per se.
Also, three section (background, and recommendation for developers) are non-normative, marked as such, and their prose has been fixed.
I'm not sure yet if we want to capitalize the words, maybe we do. This is easily done in any case, because they only appear normatively now.
This fixes #301.
Preview | Diff