CLOUDP-303333 Improve --file description for auto-generated commands #3709
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
github-actions
bot
added
the
need-doc-review
|
APIx Bot |
: a message has been sent to Docs Slack channel 🚀.
fmenezes
commented
Mar 5, 2025
| @@ -60,7 +60,7 @@ jobs: | |||
| if: env.review_needed == 'true' && steps.append_comment.outputs.previous_comment_id == '' | |||
| env: | |||
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_DOCS }} | |||
| SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK | |||
There was a problem hiding this comment.
this should fix docs bot messages
internal/cli/api/api.go
Outdated
| @@ -253,7 +253,7 @@ func convertAPIToCobraCommand(command api.Command) (*cobra.Command, error) { | |||
| addVersionFlag(cmd, command, &version) | |||
|
|
|||
| if needsFileFlag(command) { | |||
| cmd.Flags().StringVar(&file, flag.File, "", "path to the file which contains the api request contents") | |||
| cmd.Flags().StringVar(&file, flag.File, "", "path to the file which contains the api request contents, alternatively you may pass standard input") | |||
There was a problem hiding this comment.
What about this:
Path to your API request file. Leave empty to use stdin instead - you must provide one or the other, but not both.
The main reason we're changing this sentence is to:
- Make it clear that either file or stdin is required
- Make it clear that you have to provide one or the other but not both
That was the main feedback we got from the docs team.
|
Coverage Report 📈
|
jeroenvervaeke
approved these changes
Mar 5, 2025
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.
Proposed changes
Improve --file description for auto-generated commands
Jira ticket: CLOUDP-303333
Closes #[issue number]
Checklist
make fmtand formatted my codeFurther comments