posit-dev / posit-dev/raghilda

Document supported attribute filter operators

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

Nobody has claimed this yet.

Dominant language
Python
Stars
36
Forks
0
Avg merge
17m
Merged PRs (30d)
3

Description

Summary

The attribute filters guide (user_guide/03-attribute-filters.qmd) demonstrates filter usage through examples but doesn't include a reference section listing all supported operators.

A user reading the guide can infer =, >=, AND, and IS NULL from the examples, but there's no way to discover the full set of available operators without reading the source code.

Suggested addition

A "Filter Operators" reference section listing:

Comparison operators (SQL-like string / dict AST):

  • = / eq, != / ne
  • > / gt, >= / gte, < / lt, <= / lte
  • IN / in, NOT IN / nin
  • IS NULL, IS NOT NULL

Logical operators:

  • AND, OR

Dict AST structure:

  • {"type": "<operator>", "key": "<column>", "value": <value>}
  • {"type": "and"|"or", "filters": [...]}

This could go between the current "Recap: Declaring Attributes" and "Built-In Backend Columns" sections, or as a new standalone section.

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

Edit user_guide/03-attribute-filters.qmd between “Recap: Declaring Attributes” and “Built-In Backend Columns.” Review the existing examples, then add a “Filter Operators” reference covering comparison and logical operators plus the specified dict AST structures. Done means readers can discover the supported operators without consulting source code.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.