json-schema-org / json-schema-org/website

[📝 Docs]: Clarification in the omitting of some elements in the Tuple Validation Documentation

Open Beginner friendly
#2,109 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

📝 Documentation Status: Stale Status: Triage
Dominant language
HTML
Stars
169
Forks
484
Avg merge
2d 2h
Merged PRs (30d)
6

Description

What Docs changes are you proposing?

https://github.com/json-schema-org/website/blob/dbfaf31642d82bb584dcc6352886b358c250742a/pages/understanding-json-schema/reference/array.md?plain=1#L170
In the JSON Schema Docs, in the Reference section, Array Subsection, under the Tuple Validation heading, it is written that

It's okay to not provide all of the items:

And an example has been given without some items included. I think that a point should be mentioned with that line that the provided items should also be in the correct order from the start according to the tuple/array schema.
Something like

It's okay to not provide all of the items, but they should be in a consecutive order from the start:

If there is any point that I am missing or a correction, please let me know!

Code of Conduct
  • I agree to follow this project's Code of Conduct

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.

Research direction

Start with pages/understanding-json-schema/reference/array.md at the Tuple Validation section around the linked line. Clarify that omitted tuple items must be supplied consecutively from the start, and ensure the accompanying example supports that explanation; the documentation is done when the ordering requirement is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.