[eas-cli] Fix channel:pause and channel:resume argument descriptions - #3887
Open
patrickwehbe wants to merge 2 commits into
Open
[eas-cli] Fix channel:pause and channel:resume argument descriptions#3887patrickwehbe wants to merge 2 commits into
patrickwehbe wants to merge 2 commits into
Conversation
The NAME argument for channel:pause and channel:resume described itself as "Name of the channel to edit", copied from channel:edit. Update the descriptions to refer to pausing and resuming, and regenerate the matching README lines by hand.
|
Subscribed to pull request
Generated by CodeMention |
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.
Why
The
NAMEargument foreas channel:pauseandeas channel:resumeis described as "Name of the channel to edit". That wording was copied over fromchannel:editand never updated, so--helpfor both commands tells you to pass the channel to "edit" even though neither command edits the channel.How
Updated the argument description in
packages/eas-cli/src/commands/channel/pause.tsto "Name of the channel to pause" and inpackages/eas-cli/src/commands/channel/resume.tsto "Name of the channel to resume". I also updated the two matching lines inpackages/eas-cli/README.mdby hand to mirror the change, since running the fullyarn oclif readmeregeneration pulls in the whole monorepo install.channel:editkeeps its original description.I added a bug-fix entry to
CHANGELOG.mdunder themainsection.Test Plan
This is a string-only change to the command metadata. Help output now reads correctly: