You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
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.
The text was updated successfully, but these errors were encountered: