Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.

Convert/rewrite our docstrings to use NumPy-style doc strings (very low priority for release) #337

Closed
msteffen opened this issue Aug 25, 2021 · 0 comments · Fixed by #339
Closed

Convert/rewrite our docstrings to use NumPy-style doc strings (very low priority for release) #337

msteffen opened this issue Aug 25, 2021 · 0 comments · Fixed by #339
Labels
docs

Comments

@msteffen
Copy link
Contributor

Discussed in 8/18/2021 python-pachyderm product meeting. We'd like to switch away from pdoc, which IIUC means changing the syntax we use in our docstrings, from the current syntax (markdown-like?) to numpy-style docstrings that RTD and other tools can parse
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation pachyderm/python-pachyderm
1 participant
@msteffen