posit-dev / posit-dev/py-shiny

API: Reference for "reactive.event" decorator missing in docs

Open
#361 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It would be helpful to add API reference for shiny.reactive.event examples

https://shiny.rstudio.com/py/api/reference/shiny.event.html? is deprecated and points to using shiny.reactive.event but there is no quick/direct reference to this.

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 by reviewing the current API documentation and the deprecated shiny.event reference linked in the issue. Add a direct API reference for shiny.reactive.event with examples, and verify that the deprecated reference points users to the new documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.