QuantEcon / QuantEcon/QuantEcon.py
Improvements to docs for MarkovChain
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
At the moment, with properties, we see no documentation:
In [9]: import quantecon as qe
In [10]: m = qe.MarkovChain([[1, 0], [0, 1]])
In [11]: m.stationary_distributions?
Type: property
String form: <property object at 0x7f34106c45e8>
Docstring: <no docstring>
However, as @cc7768 pointed out, it is possible to get documentation to show up here but adding docstrings to the functions associated with the property.
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 by locating the MarkovChain implementation and its stationary_distributions property. Inspect the functions associated with the property and the documentation shown by interactive help. Done means the relevant property documentation is displayed instead of .
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
- 58/100