posit-dev / posit-dev/py-shiny

Show version on API docs

Open
#519 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
1.8k
Forks
135
Avg merge
2d 18h
Merged PRs (30d)
21

Description

https://shiny.rstudio.com/py/api/ doesn't say what version it corresponds to. In fact, I can't find the current version number anywhere on the site. It would be useful to show it so that as a user I can confirm that the library version I'm using locally corresponds to what is documented there.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the API documentation URL, https://shiny.rstudio.com/py/api/, and trace how that site is generated and where the library version can be obtained. The work is complete when the published API documentation visibly identifies its corresponding Shiny for Python version and users can compare it with their local library.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.