QuantEcon / QuantEcon/QuantEcon.py
[Documentation] Include a list of functions and objects that are available at the top level of the packakge
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
Document what objects are directly importable from quantecon top level of package.
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 inspecting the quantecon top-level package and its public imports to identify the functions and objects directly available to users. Document that list in the project's existing documentation location; done means users can see which objects are importable from quantecon itself.
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