docs(query): Say which operators fail on an index of 1<<24 or more

Open Beginner friendly
#254 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
go

Research direction

Start with the Edit errors table in docs/query.md and the TestEditDocExamples cases. Check how the table describes the = and += failures, then add the requested ^? example row. Done means the condition names = and +=, and the test example confirms ^? leaves the array unchanged without an error.

Written by the indexing model from the issue text.

Description

The Edit errors table in docs/query.md lists "An index of 1<<24 or more" as a failure with array index 16777216 exceeds maximum 16777215, without naming the operator. = and += fail as documented (.a[16777216] = 1, .a.16777216 = 1), but ^? does not: .a[16777216] ^? on {"a": [0]} leaves {"a": [0]} with no error, as the Go equivalents section already says for deleting an index past the end.

Qualify the condition as "An index of 1<<24 or more with = or +=", and add a TestEditDocExamples row for the ^? case.

Dominant language
Go
Stars
7
Forks
2
Avg merge
9h 17m
Merged PRs (30d)
52

Getting set up

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 mojatter/tree

All issues in mojatter/tree

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.