array-api icon indicating copy to clipboard operation
array-api copied to clipboard

Capitalizing RFC 2119 words like SHOULD

Open asmeurer opened this issue 3 years ago • 3 comments

@tomwhite suggested at https://github.com/dask/dask/pull/8750#discussion_r815757335 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.

asmeurer avatar Feb 28 '22 20:02 asmeurer

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 avatar Apr 04 '24 00:04 kgryte

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

rgommers avatar Apr 04 '24 20:04 rgommers

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

asmeurer avatar Apr 04 '24 20:04 asmeurer