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

🧹 Clarification: MAYs in several sections are linquistic, not requirements #1573

Open
gregsdennis opened this issue Jan 15, 2025 · 1 comment · May be fixed by #1580
Open

🧹 Clarification: MAYs in several sections are linquistic, not requirements #1573

gregsdennis opened this issue Jan 15, 2025 · 1 comment · May be fixed by #1580

Comments

@gregsdennis
Copy link
Member

gregsdennis commented Jan 15, 2025

Specification section

Validation spec:

  • deprecated
  • readOnly / writeOnly

What is unclear?

There are several "MAY" words that don't need to be capitalized as they are neither constrictive nor permissive. This usage is just informing the reader that something could happen in the data that the schema is describing; it's not related to an implementation, tooling, or an application.

Proposal

Fix the casing to lowercase.

Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)

No

@gregsdennis gregsdennis added this to the stable-release milestone Jan 15, 2025
@gregsdennis gregsdennis moved this to In Discussion in Stable Release Development Jan 15, 2025
@gregsdennis gregsdennis changed the title 🧹 Clarification: MAYs in deprecated section are linquistic, not requirements 🧹 Clarification: MAYs in several sections are linquistic, not requirements Jan 15, 2025
@jdesrosiers
Copy link
Member

Thanks for looking out for things like this. I think there's quite a few places in the spec where we use these uppercase terms inappropriately.

@gregsdennis gregsdennis moved this from In Discussion to Awaiting PR in Stable Release Development Jan 19, 2025
@gregsdennis gregsdennis linked a pull request Feb 2, 2025 that will close this issue
@gregsdennis gregsdennis moved this from Awaiting PR to In Progress in Stable Release Development Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants