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

Make docstrings to be nice with pydoc #393

Open
jdavid opened this issue Jul 22, 2014 · 0 comments
Open

Make docstrings to be nice with pydoc #393

jdavid opened this issue Jul 22, 2014 · 0 comments

Comments

@jdavid
Copy link
Member

jdavid commented Jul 22, 2014

In some doc-strings we use formatting rules specific to Sphinx, but which make the interactive help (pydoc) to look bad.

This issue is about:

  • defining how we should write some recurrent stuff, like documenting input parameters and return values.
  • rewrite the doc-strings so they look fine on pydoc, even if that means losing some features with Sphinx, like cross references.

Note. If we had the resources, we would do like Python does, and document things twice: once in the doc-strings and a feature rich version in the rst files. But in any case the doc-strings must be usable with pydoc, so lets start with that.

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

No branches or pull requests

1 participant