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

Improve documentation #19

Open
A-CGray opened this issue Mar 28, 2022 · 0 comments
Open

Improve documentation #19

A-CGray opened this issue Mar 28, 2022 · 0 comments
Labels
documentation This is related to documentation good first issue Good for newcomers

Comments

@A-CGray
Copy link
Member

A-CGray commented Mar 28, 2022

Description of feature

Potential solution

  • fix some docstrings (e.g. math rendering etc.) and sphinx linking to other functions
  • add a bit more text to explain the examples, or make them more uniform
  • move some of the installation notes from the README to the RST files
@A-CGray A-CGray added good first issue Good for newcomers documentation This is related to documentation labels Mar 28, 2022
@ewu63 ewu63 mentioned this issue Jun 7, 2022
Merged
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation This is related to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@A-CGray