Adding descriptions to two settings - 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

Adding descriptions to two settings #1733

Closed john-science closed 3 months ago

john-science commented 3 months ago

What is the change?

Adding descriptions to two settings: CONF_COPY_FILES_FROM and CONF_COPY_FILES_TO.

Also, while I was at it, this work let me to:

Improve the docstring on the method MainInterface._moveFiles()
Add a DeprecationWarning that soon settings will require descriptions (same as with parameters).
I fixed some formatting and docstrings as I found them (sorry!)

Why is the change being made?

To close #1727

These two settings are slightly complicated, and interact heavily, so they should have descriptions that explain their use.

Checklist

[X] This PR has only one purpose or idea. (Except the random cleanup I did. Sorry!)
[X] Tests have been added/updated to verify any new/changed code.

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

[X] The release notes have been updated if necessary.
[X] The documentation is still up-to-date in the doc folder.
[X] The dependencies are still up-to-date in pyproject.toml.