documentation on composition
Open
Nobody has claimed this yet.
documentation
improvement
- Dominant language
- Python
- Stars
- 838
- Forks
- 123
- Avg merge
- 7h 58m
- Merged PRs (30d)
- 12
Description
It is possible to compose Klein apps with both other Klein apps and other Twisted Resource objects. The idioms already exist (branch routes and making resource objects out of klein apps) but we should document it clearly on klein.readthedocs.io.
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
Start at klein.readthedocs.io and review the existing documentation for branch routes and making Klein apps into Twisted Resource objects. Document how to compose Klein apps with one another and with other Twisted Resource objects, with clear examples of both idioms; done when these composition patterns are explained.
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