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.

Sign up for GitHub

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

Jump to bottom

Order of sections in operator docstrings #854

Open

kohr-h opened this issue Jan 22, 2017 · 0 comments

Labels

status: discussion topic: documentation type: reference

Member

kohr-h commented Jan 22, 2017

As discussed here there needs to be a guideline about the order of documentation sections, at least for classes.

My view on this is:

Parameters (Raises, Yields, anything API-related) as far up as possible, they're needed the most.
Examples immediately afterwards, equally (or even more) important
Notes - often contain important (math) details, but useful for initial understanding, not so much for later usage of a class
See Also
References

kohr-h added status: discussion topic: documentation labels

kohr-h mentioned this issue

MAINT: rename TensorGrid->RectGrid and remove RegularGrid #841

Merged

aringh added the type: reference label

aringh mentioned this issue

Policy for copyright statement in ODL #1398

Open

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