Use all caps pure-tokens in command "Usage:" #184
Merged
Conversation
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
In the command page's "Usage:", the lower case `name` was used in case of a `pure-token`.
However, the all caps `token` should be used instead. For MIGRATE, this makes an even bigger
difference (see `empty-string`):
Before:
```
Usage:
MIGRATE host port 〈 key | empty-string 〉 destination-db timeout [ copy ] [ replace ] [ AUTH auth | AUTH2 username password ] [ KEYS keys ] [ [ KEYS keys ] ... ]
```
Now:
```
Usage:
MIGRATE host port 〈 key | "" 〉 destination-db timeout [ COPY ] [ REPLACE ] [ AUTH auth | AUTH2 username password ] [ KEYS keys ] [ [ KEYS keys ] ... ]
```
Signed-off-by: Simon Baatz <[email protected]>
|
This looks good. I get a little itchy when there are changes to the command reference parser due to the possibility of unintended consequences, but I ran a diff vs the command rendering on current iteration of the website and indeed this appears to only affect spacing (fine/irrelevant) and the intended capitalization. |
|
@madolson would you mind giving this a review as well? |
madolson
approved these changes
Jan 7, 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.
In the command page's "Usage:", the lower case
namewas used in case of apure-token. However, the all capstokenshould be used instead. For MIGRATE, this makes an even bigger difference (seeempty-string):Before:
Now:
This addresses a part of #116
By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.