posit-dev / posit-dev/py-shiny
Descriptions are not being passed to documentation page for types
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
Many of the items documented at https://shiny.posit.co/py/api/MiscTypes.html have descriptions in the source code, but these descriptions do not appear in the function reference, even though other elements of the documentation do.
For example, the source code for types.ImgData includes
class ImgData(TypedDict):
"""
Return type for :func:`~shiny.render.image`.
See Also
--------
~shiny.render.image
Example
-------
See :func:`~shiny.render.image`.
"""
src: str
"""The ``src`` attribute of the ``<img>`` tag."""
width: NotRequired[str | float]
"""The ``width`` attribute of the ``<img>`` tag."""
height: NotRequired[str | float]
"""The ``height`` attribute of the ``<img>`` tag."""
alt: NotRequired[str]
"""The ``alt`` attribute of the ``<img>`` tag."""
style: NotRequired[str]
"""The ``style`` attribute of the ``<img>`` tag."""
coordmap: NotRequired[Any]
"""TODO """
but the description in the first line does not appear in the rendered documentation:
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/types.py and compare the ImgData source docstrings with the rendered MiscTypes.html entry for shiny.types.ImgData. Trace the documentation build path that produces this page and run it locally; done means the type and field descriptions shown in the source appear in the generated function reference.
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
- 45/100