pymc-devs / pymc-devs/pytensor
API docs restructuring
Open
Nobody has claimed this yet.
beginner friendly
docs
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
Description
Description
- Implement some basic docs for scalar
- Include link/compile inside compile section
- Move d3viz and include ipython inside printing section
- Extend misc
- Have other types (maybe move inside misc section), with typed list, slice, nonetype (and anything else we may have)
- Raise_op, breakpoint inside misc
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 current API documentation sections corresponding to scalar, compile, printing, and misc. Review how d3viz, ipython, link, compile, raise_op, breakpoint, and the other listed types are currently organized; the work is done when these items are documented and placed in the requested sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100