Capitalizing RFC 2119 words like SHOULD

Open
#397 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by locating the specification text and reviewing its uses of RFC 2119 words such as "SHOULD". Check the surrounding wording and decide on a consistent capitalization or emphasis convention; done means the specification applies that convention clearly and consistently.

Written by the indexing model from the issue text.

Description

Document Formatting

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

Dominant language
Python
Stars
281
Forks
52
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from data-apis/array-api

All issues in data-apis/array-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.