posit-dev / posit-dev/py-shiny
Consider alternative name for "modules"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
We chose the name "modules" for two main reasons:
- It's the same as the R term which makes transitioning a bit easier
- Shiny modules are pretty similar to generic Python modules so it made sense to use the name
The name does seem to create confusion in some users and is difficult to explain. For example I ended up saying: "the Shiny module_ui function is in Shiny's UI module".
According to chatGPT the most common term for this is "Component" so maybe we should go with @component.ui and @component.server.
| Web Framework | Reusable Elements |
|---|---|
| React | Components |
| Angular | Components |
| Vue.js | Components |
| Ember.js | Components |
| Backbone.js | Views or Templates |
| Meteor.js | Templates or Components |
| Express.js | Middleware or Router Middleware |
| Next.js | Components |
| Svelte | Components |
| Preact | Components |
| Django | Templates or Views |
| Dash | Components |
| Streamlit | Components or Widgets |
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 by reviewing the current module_ui and module.server terminology and how Shiny modules are described in the project. Compare the proposed component naming with existing usage and the issue's examples. Done requires an agreed alternative name and a clearly defined migration scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- full-stack
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100