Catchall PR for minor formatting/typo updates to docstrings - Githubissues

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality

https://terrapower.github.io/armi/

Apache License 2.0

224 stars 87 forks source link

Catchall PR for minor formatting/typo updates to docstrings #1634

Closed mgjarrett closed 8 months ago

mgjarrett commented 8 months ago

What is the change?

Typographical and formatting updates to docstrings and implementation detail that is going into the SQA docs for ARMI.

Why is the change being made?

Edits are being made as part of a review of the SQA documentation for ARMI.

Checklist

[x] This PR has only one purpose or idea.
[ ] ~Tests have been added/updated to verify that the new/changed code works.~

[x] The code style follows good practices.
[x] The commit message(s) follow good practices.

[x] The release notes (location doc/release/0.X.rst) are up-to-date with any important changes.
[x] The documentation is still up-to-date in the doc folder.
[x] If any requirements were affected, mention it in the release notes.
[x] The dependencies are still up-to-date in pyproject.toml.

mgjarrett commented 8 months ago

@opotowsky @john-science I don't see any other fixes coming in. Should we merge this now?