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

Add documentation for compute function kwargs #707

Closed
f0uriest opened this issue Oct 16, 2023 · 1 comment · Fixed by #987
Closed

Add documentation for compute function kwargs #707

f0uriest opened this issue Oct 16, 2023 · 1 comment · Fixed by #987
Assignees
Labels
documentation Add documentation or better warnings etc. hackathon Stuff to work on during hackathon

Comments

@f0uriest
Copy link
Member

A number of compute functions can take keyword arguments for things like the adiabatic index, vector basis, boozer resolution etc. We should add documentation for those, maybe in a new column in https://desc-docs.readthedocs.io/en/stable/variables.html

@f0uriest f0uriest added the documentation Add documentation or better warnings etc. label Oct 16, 2023
@f0uriest
Copy link
Member Author

Add docstrings as value of kwarg in register compute fun

add docs to list of variables, point compute function docstring to that

@ddudt ddudt self-assigned this Jan 24, 2024
@ddudt ddudt mentioned this issue Feb 1, 2024
@f0uriest f0uriest added the hackathon Stuff to work on during hackathon label Mar 7, 2024
@f0uriest f0uriest self-assigned this Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add documentation or better warnings etc. hackathon Stuff to work on during hackathon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants