posit-dev / posit-dev/py-shiny
[docs] `render.DataGrid` and `render.DataTable` should mention selected rows
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
render.data_frame mentions the {id}_selected_rows() input here https://shiny.posit.co/py/api/render.data_frame.html#row-selection, but neither render.DataGrid now render.DataTable mention this information, making it hard to discover.
Discoverability might be improved by #975, but the documentation for render.DataGrid and render.DataTable should mention how to access selected rows.
Contributor guide
No contributing guide indexed for this repository
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 render.data_frame documentation's row-selection section, then review the render.DataGrid and render.DataTable API pages linked in the issue. Update both pages to explain how to access selected rows through the {id}_selected_rows() input, and confirm the information is discoverable on each page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100