result document: consider documenting that child order is unspecified
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.2k
- Forks
- 726
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 7
Description
the order of children nodes in the ResultDocument is not specified today, and we should document this as such, or provide a deterministic sort order (perhaps by lexicographically sorting children in the ResultDocument nodes).
without this, ports to other languages may try to preserve the order of children in order that ResultDocuments match byte-by-byte, which doesn't seem meaningful (and may even hamper work, such as alternative optimization strategies).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the ResultDocument definition and any existing documentation or tests for child-node ordering. Confirm whether the intended outcome is documenting unspecified order or defining deterministic sorting; done when the chosen behavior is stated clearly and reflected in the relevant documentation or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100