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

Submodule functions should be represented with fully qualified names in the docs #14

Open
andykee opened this issue Oct 21, 2020 · 0 comments

Comments

@andykee
Copy link
Owner

andykee commented Oct 21, 2020

When referring to classes and methods in submodules in the docs, it is preferable to provide a fully qualified name. For example,

detector.pixelate()

is preferable to

pixelate()

This is simple to achieve in the documentation:

.. currentmodule:: lentil

:func:`detector.pixelate`

The documentation should be globally updated to make this change.

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