-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[DOC] add TEMPERATURE_MODEL_PARAMETERS to api.rst #1036
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
Conversation
See if you like what this looks like in the API reference |
also if it's okay to make an exception for stickler, it's a long line in the example of the docstring, I don't think it will look as good wrapped, but maybe? |
Thanks @mikofski! Is it easy to put the whole docstring on its own page and keep only the first line on the rendered |
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
I had troubles with that, b/c the |
I was afraid it wasn't going to be easy but thanks for checking. I suggest we keep them on |
Thanks @wholmgren I've fixed the stickler issues, and caught a typo. I think it's good now |
Thanks @mikofski! Test failure is unrelated so merging. |
Tests addedno code, only documentationdocs/sphinx/source/api.rst
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).add
TEMPERATURE_MODEL_PARAMETERS
to the documentation