Reword descriptions in manual. #23
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
lagru
approved these changes
Nov 21, 2024
| @@ -127,13 +127,13 @@ def report_execution_time(): | |||
| "-o", | |||
| "--out-dir", | |||
| type=click.Path(file_okay=False), | |||
| help="Set explicit output directory.", | |||
| help="Set output directory explicitly.", | |||
There was a problem hiding this comment.
Thanks for checking in, I don't really get why this needs rewording but I don't mind the tiny change either.
There was a problem hiding this comment.
The first motivation is consistency: If I had read, for instance,
-o, --out-dir DIRECTORY Set explicit output directory.
--config FILE Set explicit configuration file.I probably wouldn't have noticed anything (say, the area for improvement). Because it would have looked consistent. But seeing
-o, --out-dir DIRECTORY Set explicit output directory.
--config FILE Set explicitly configuration file.made me wonder why "Set explicit [noun]" and then "Set explicitly [noun]?"
Second, my understanding of the semantics is that the options let you "do something explicitly" (which, btw, sounds more natural than "do explicitly something") and not so much "do an explicit thing").
There was a problem hiding this comment.
Ah, that makes sense. Thanks for explaining. :)
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.
@lagru just noticed this!