QuantEcon / QuantEcon/QuantEcon.py
Final quadrature cleanup
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
I have reviewed the quadrature branch and I think that code is ready to merge.
There are a couple of things that we should still clean up soon, but that shouldn't prevent the branch from being merged. Here are the residual clean-up items:
- In the docstring for
qnwequiwe don't know what theequidist_ppargument does. - We need to fill in a description of the docstring for
ce_util.gridmake - The example notebook has a lot of code and pretty pictures, but not much exposition. It could use some love to make it a better teaching tool.
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
Locate the docstrings for qnwequi and ce_util.gridmake, then review the example notebook mentioned in the issue. Clarify the equidist_pp argument, document gridmake, and add explanatory text to the notebook so it works better as a teaching tool.
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
- 25/100