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

Move equations to Notes #2677

Open
dopplershift opened this issue Sep 16, 2022 · 0 comments
Open

Move equations to Notes #2677

dopplershift opened this issue Sep 16, 2022 · 0 comments
Labels
Area: Docs Affects documentation good first issue Straightforward issues suitable for new and inexperienced contributors to the project Type: Maintenance Updates and clean ups (but not wrong)

Comments

@dopplershift
Copy link
Member

In the docs, we should consistently put the equations, implementation details in the Notes section of the docs. This way, they appear below the documentation of the parameters and returns.

We should also make the equations consistent with regards to defining terms.
@dopplershift dopplershift added Area: Docs Affects documentation Type: Maintenance Updates and clean ups (but not wrong) good first issue Straightforward issues suitable for new and inexperienced contributors to the project labels Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: Docs Affects documentation good first issue Straightforward issues suitable for new and inexperienced contributors to the project Type: Maintenance Updates and clean ups (but not wrong)
Projects
Python
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dopplershift