Say "dry run" in the dry-run description - #6
Merged
Merged
Conversation
The description explained the behavior without naming it. GitHub renders only the description as a workflow_dispatch checkbox label, so anyone scanning for the term found nothing -- the prose was more obfuscating to a developer than the bare term would have been.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
dry-runinput described what it does without naming it:Reads fine, searches badly. GitHub renders only the description as the
checkbox label for a
workflow_dispatchinput, so someone looking for the dryrun option scans the page and finds the words nowhere — the prose was more
obfuscating than the bare term.
Now leads with the term and keeps the explanation after it. README row updated
to match.