app vs router
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 838
- Forks
- 123
- Avg merge
- 7h 58m
- Merged PRs (30d)
- 12
Description
When we write this is documentation:
app = Klein()
This suggests that an instance of Klein is an "application", which is confusing because we sometimes also write something like:
class MyApplication(object):
app = Klein()
Is an instance of MyApplication an "application" also? I think that we should come up with consistent and appropriate terminology, which will aid users as they learn how to use this framework.
Contributor guide
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
The issue does not name documentation files or tests. Review the documentation uses of “application,” “app,” and “router,” including the Klein and MyApplication examples, then define consistent terminology and update the affected documentation once the wording is agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100