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

Check docstrings formatting API reference #100

Closed
nikosavola opened this issue Feb 15, 2022 · 0 comments · Fixed by #101
Closed

Check docstrings formatting API reference #100

nikosavola opened this issue Feb 15, 2022 · 0 comments · Fixed by #101

Comments

@nikosavola
Copy link
Contributor

I noticed there's quite a lot of API docstrings that are not formatted properly by Sphinx.

As a random example, pyEPR.calcs.convert has improperly formatted Python code and LaTeX typesetting w/o the Sphinx math directive. Another example is pyEPR.calcs.back_box_numeric.black_box_hamiltonian with in-line math.
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docstrings formatting nikosavola/pyEPR
1 participant
@nikosavola