Skip to content

Capitalizing RFC 2119 words like SHOULD #397

@asmeurer

Description

@asmeurer
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.

Activity

kgryte

kgryte commented on Apr 4, 2024

@kgryte
Contributor

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.

added this to the v2024 milestone on Apr 4, 2024
rgommers

rgommers commented on Apr 4, 2024

@rgommers
Member

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

asmeurer

asmeurer commented on Apr 4, 2024

@asmeurer
MemberAuthor

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

modified the milestones: v2024, v2025 on Jan 23, 2025

5 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @asmeurer@rgommers@kgryte

        Issue actions

          Capitalizing RFC 2119 words like SHOULD · Issue #397 · data-apis/array-api