posit-dev / posit-dev/py-shiny
Documentation is missing many links to type structures
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
Missing links when rendering doc page:
/api/ExFillingLayout.html-
shiny.ui.click_opts -
shiny.ui.dblclick_opts -
shiny.ui.brush_opts -
shiny.ui._plot_output_opts.BrushOpts -
shiny.ui._plot_output_opts.ClickOpts -
shiny.ui._plot_output_opts.DblClickOpts -
shiny.ui._plot_output_opts.HoverOpts
-
- (Repeat this for many other pages)
Should we expose them?
Other questions:
- Should we expose
TypeVars? - Should we expose other data structures that are used for typing?
- If so, should they be moved to
shiny.types?
- If so, should they be moved to
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 rendered /api/ExFillingLayout.html page and the listed shiny.ui option types, then inspect how other API pages expose typing structures. Resolve the policy questions for TypeVars and other typing-only data structures, including whether they belong in shiny.types; done means the exposure rules are decided and applied consistently across the affected pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100