Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Capitalizing RFC 2119 words like SHOULD #397

Open
asmeurer opened this issue Feb 28, 2022 · 3 comments
Open

Capitalizing RFC 2119 words like SHOULD #397

asmeurer opened this issue Feb 28, 2022 · 3 comments
Labels
Document Formatting Document formatting or styling.
Milestone

Comments

@asmeurer
Copy link
Member

@tomwhite suggested at dask/dask#8750 (comment) that we should capitalize RFC 2119 words like "SHOULD" in the spec to make it clearer that we are following the RFC.

Another option might be to bold the words instead of capitalizing them.

@kgryte
Copy link
Contributor

kgryte commented Apr 4, 2024

I think the option of using bold text should suffice. While all-caps is a common convention, it does add a fair amount of visual noise. I think encoding RFC terms using bold text is something we can address in the current draft specification and then continue to enforce moving forward. For prior revisions, we can leave as is.

@kgryte kgryte added this to the v2024 milestone Apr 4, 2024
@kgryte kgryte added the Document Formatting Document formatting or styling. label Apr 4, 2024
@rgommers
Copy link
Member

rgommers commented Apr 4, 2024

That seems like a reasonable option. I'd prefer to avoid capitalized words yell at me:)

@asmeurer
Copy link
Member Author

asmeurer commented Apr 4, 2024

An idea to automatically bold those words (I haven't tested it). https://chat.openai.com/share/7467ec88-0d8f-4352-9a5b-5b43fe6b8f02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Document Formatting Document formatting or styling.
Projects
None yet
Development

No branches or pull requests

3 participants