Tutorials should demonstrate writing a `Model.model()` method
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 29
- Forks
- 9
- Avg merge
- 9d 9h
- Merged PRs (30d)
- 8
Description
We may wish to ship a view particular Model subclasses that do common things, but in light of the pyrenew principles, I think we want to encourage users to write their own subclasses of Model and provide tutorials for that. This makes the process of understanding what goes into a model and how it all fits together less opaque.
EDIT for clarity
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 with the PyRenew principles section in docs/source/developer_documentation.rst and inspect the existing tutorial structure. Add tutorial material showing users how to subclass Model and write a Model.model() method, with enough explanation to make the model components and their relationships understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100