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

PDF Documentation needs updating #321

Open
willGraham01 opened this issue May 24, 2023 · 0 comments
Open

PDF Documentation needs updating #321

willGraham01 opened this issue May 24, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux Related to the user experience (CLI, workflow etc)

Comments

@willGraham01
Copy link
Collaborator

Having been working on #320, it is quite clear that the PDF documentation needs an update.

  • There are some input variables like exdetintegral that are required but are not documented.
  • The compact source condition/criterion is mentioned in the testing section of doc/developers but we don't actually have an explanation of what it is/means in the documentation.
  • The input flags use_pstd and use_bli are not mentioned at all.
  • The choice of interpolation scheme is not mentioned. Nor is it mentioned when one may wish to use cubic over band-limited or vice-versa.
@willGraham01 willGraham01 added enhancement New feature or request documentation Improvements or additions to documentation ux Related to the user experience (CLI, workflow etc) labels May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux Related to the user experience (CLI, workflow etc)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@willGraham01