posit-dev / posit-dev/py-shiny
Missing documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
There are a few features I noticed do work in py-shiny but I could not find documentation for them anywhere. It's entirely possible that the documentation does exist and I just didn't know where to look.
- Using
label = Nonewill not create a label - To create attributes that have a dash, such as
data-test, using the named arguments method, you need to convert dashes to underscores - It's possible to create multiple
def: _()forreactive.Effect. Maybe this is common knowledge in python, but when I saw that a reactive.Effect is being used by defining a function named_, I thought to myself "ok, but what do I name the other observers? Can I just use any random name, but they have to be unique?" but I noticed that I can just reuse the same definition
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
Search the py-shiny documentation for label = None, dashed attributes such as data-test, and repeated reactive.Effect definitions. Confirm whether these behaviors are already documented; done means adding clear guidance for each missing behavior in the appropriate documentation location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100