queryverse / queryverse/Query.jl
Doc comments
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Julia
- Stars
- 403
- Forks
- 48
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 6
Description
- Page getting started / Standalone query operators: "The example from the previous section can also be ..." . Where does this refer to? The previous page has no example, it is the intro page.
- A suggestion for the page "Gettinge started" : it should have a section that actually defines what
_and{}mean ? Introduction, Getting Started and not even Standalone Query commands seem to define them. Of course I know that_is supposed to stand for the "current named tuple" but maybe it is good to have a quick paragraph defining these concepts? - Page Data sources / Any iterable type : The page uses
start, next, donewhich are invalid. Is the paragraph in general correct? I remember from the workshop that anything that behaves as an iterator of NamedTuples can be a data source.
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 with the Getting Started, Standalone query operators, and Data sources / Any iterable type pages named in the issue. Check the previous-section reference, define _ and {}, and verify the iterator terminology against the documented data-source behavior. Done means the affected text is accurate, clear, and internally consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100