Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generating a docstring from a numpydoc object #186

Closed
hmaarrfk opened this issue Aug 11, 2018 · 4 comments
Closed

Generating a docstring from a numpydoc object #186

hmaarrfk opened this issue Aug 11, 2018 · 4 comments

Comments

@hmaarrfk
Copy link
Contributor

Do you provide a way to generate a docstring from a numpydoc object?

I tried looking through the docs (and source) and I couldn't find anything of that sort.

@jnothman
Copy link
Member

jnothman commented Aug 11, 2018 via email

@hmaarrfk
Copy link
Contributor Author

Whoa, so cool.

Is there a way to get it closer to a round trip? That is, removing the restructured text formatting?

I would like to append the docs of a function, but allow other python modules to keep parsing them.

@jnothman
Copy link
Member

jnothman commented Aug 12, 2018 via email

@hmaarrfk
Copy link
Contributor Author

Cool seems appropriate! Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants