astronomy-commons / astronomy-commons/lsdb
Use query in the documentation
- Dominant language
- Python
- Stars
- 55
- Forks
- 26
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
Description
Review documentation and ensure that we use query throughout the documentation.
Point out that an user can use masking if wanted. I suggest one example in the Section 1.5. Row filtering (e.g. .query) comparing the synatx of these two options. Add this part to Section 1.5 if it does not exist already.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the documentation around Section 1.5, “Row filtering (e.g. .query),” and search the rest of the docs for inconsistent query terminology. Check whether the masking note and comparison example already exist; done means terminology is consistent, masking is explained as optional, and the two syntax options are compared in Section 1.5.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100