Updating vip cache commands descriptions and examples to follow the VIP-CLI style guide #1877
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
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
yolih
reviewed
Jun 13, 2024
|
sanmai
approved these changes
Jun 18, 2024
| usage: | ||
| `${ exampleUsage } https://example-app-develop.go-vip.co/sample-page/` + | ||
| '\n - Purged URL: https://example-app.develop.go-vip.co/sample-page/', | ||
| description: 'Purge the page cache for a single URL.', |
There was a problem hiding this comment.
I just tested this and can confirm that the example output matches the actual output when that command is run successfully. 👍
|
LGTM. Thanks for the careful review, @sanmai ! |
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.
Updated the voice, tense, and format of descriptions and examples for the
vip cachecommands to follow the VIP-CLI style guide.Pull request checklist
New release checklist
Steps to Test
Observe the results of the
--helpdisplay for impacted commands, such as:vip --helpvip cache --helpvip cache purge-url --help