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

Docs #53

Closed
juddmehr opened this issue Jun 25, 2024 · 4 comments
Closed

Docs #53

juddmehr opened this issue Jun 25, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@juddmehr
Copy link
Member

Need to write docs in preparation for release.

  • Need to review tutorial and make sure it's up to date.
  • Need to review examples, and add more information, perhaps figures, etc.
  • Consider adding some prose to the api pages
  • Add one or more theory pages (decide if these should be markdown or if they should be pdfs)
@juddmehr juddmehr added the documentation Improvements or additions to documentation label Jun 25, 2024
@juddmehr
Copy link
Member Author

need to add examples for selecting non-default options, showing how options are accessed for various cases, including multi-point analyses.

Also probably want to add the verification data/plot comparison to the getting started tutorial.

@juddmehr
Copy link
Member Author

There are a lot of missing/incomplete docstrings in the polar manipulation functions that need to be added or updated.

@juddmehr
Copy link
Member Author

Added missing docstrings, updated tutorial and added verification data and plots, moved raw theory over for revision (single pdf), api seems fine for now, did a bit of reorganization. Re-organized "examples" into advanced usage pages and added some details.

After revising theory, the docs should be good to go.

@juddmehr
Copy link
Member Author

calling it good for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant