QuantEcon / QuantEcon/QuantEcon.py
Improve online documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
The documentation would be better if functions and classes all had at least one example and possibly more. E.g., see the examples here:
http://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.expon.html
There is a section devoted to examples. In the NumPy / SciPy docs, I find this section is often more useful than any other kind of documentation. I propose we push towards improving our documentation in this way.
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 a specific function, class, or entry point. Start by reviewing the project documentation and identifying public functions and classes that lack examples. Done means the agreed scope has example sections added consistently, with the documentation build or relevant examples checked.
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