queryverse / queryverse/Query.jl

Document the full set of `selectors` available to the `@select` standalone macro

Open
#285 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Julia
Stars
403
Forks
48
Avg merge
3d 6h
Merged PRs (30d)
6

Description

The documentation for the @select standalone command here mentions two selectors: occursin and endswith.

Ideally the documentation should have a subsection dealing with all the different possible types of selection, showing the syntax.

For example, from the documentation, it's not clear what syntax to use to select just two named columns.

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 the linked standalone @select command documentation and review the existing discussion of the occursin and endswith selectors. Add a subsection covering all available selection types with syntax examples, including how to select two named columns; the documentation is done when the selector forms and that example are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.