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

Minor improvements in documentation #80

Closed
jmejia8 opened this issue Oct 3, 2022 · 1 comment
Closed

Minor improvements in documentation #80

jmejia8 opened this issue Oct 3, 2022 · 1 comment

Comments

@jmejia8
Copy link

jmejia8 commented Oct 3, 2022

I am working on my review for JOSS: openjournals/joss-reviews#4736

The package seems well-coded and structured. However, some minor improvements can be made in the documentation:

  • Maybe this table of contents should be inserted in a different section
    ```@contents
  • It might be helpful to provide some bibliographical references for these examples:

## Poisson-Boltzman problem

## The Brachistochrone over a Tore

  • Please, check the syntax highlighting in the examples mentioned above.
@jmejia8
Copy link
Author

jmejia8 commented Oct 10, 2022

Solved in #84
@tmigot, thank you!

@jmejia8 jmejia8 closed this as completed Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant