posit-dev / posit-dev/py-shiny
Documentation: Returns field splits description over several rows
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
When the description provided to Returns is long, the website seems to split it across several rows. For example, here is how the website displays the Returns field of reactive.file_reader (source code):
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 shiny/reactive/_poll.py around line 258 and inspect how the Returns description for reactive.file_reader is generated for the website. Reproduce the displayed documentation and trace the rendering or formatting path responsible for splitting the description across rows. Done means the Returns description displays as a coherent field without the reported row splitting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100