Adding descriptions to two settings #1733
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keckler
reviewed
Jun 18, 2024
armi/bookkeeping/mainInterface.py
Outdated
Comment on lines
102
to
112
| - List of files to copy (cannot be directories). | ||
| - Can be of length zero (that just means no files will be copied). | ||
| - The file names listed can use the ``*`` glob syntax, to reference multiple files. | ||
|
|
||
|
|
||
| ``CONF_COPY_FILES_TO`` : | ||
|
|
||
| - List of directories to copy the files into. | ||
| - Can be of length zero; all files will be copied to the local dir. | ||
| - Can be of length one; all files will be copied to that dir. | ||
| - The only other valid length for this list _must_ be the same length as the "from" list. |
There was a problem hiding this comment.
This is all really useful context for a user. Unfortunately users won't typically see this info because it is in the docstring of a private method. Is there a better place to put this that will make it user-facing?
There was a problem hiding this comment.
Hmm... I can' think of where else it would belong.
john-science
commented
Jun 18, 2024
john-science
commented
Jun 18, 2024
keckler
approved these changes
Jun 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the change?
Adding descriptions to two settings:
CONF_COPY_FILES_FROMandCONF_COPY_FILES_TO.Also, while I was at it, this work let me to:
MainInterface._moveFiles()DeprecationWarningthat soon settings will require descriptions (same as with parameters).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
docfolder.pyproject.toml.