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.

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

Complete spectral_correction docstrings throughout #6

Open
markcampanelli opened this issue Aug 28, 2019 · 0 comments
Open

Complete spectral_correction docstrings throughout #6

markcampanelli opened this issue Aug 28, 2019 · 0 comments
Assignees
@markcampanelli
Labels
documentation Improvements or additions to documentation

Comments

@markcampanelli
Copy link
Owner

markcampanelli commented Aug 28, 2019 •
edited
Loading

Document all classes, functions, and variables (inc. data) using numpydoc docstrings.

These shall be compatible with Sphinx using the numpydoc extension.

The algorithm and implementation code for the computation of M needs special attention.
@markcampanelli markcampanelli self-assigned this Aug 28, 2019
@markcampanelli markcampanelli mentioned this issue Sep 6, 2019
Closed
@markcampanelli markcampanelli added the documentation Improvements or additions to documentation label Sep 6, 2019
@markcampanelli markcampanelli changed the title Complete docstrings throughout Complete spectral_correction docstrings throughout Sep 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@markcampanelli markcampanelli

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@markcampanelli