createaccountcmd: Improving account param description #4354
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
davidjumani
force-pushed
the
fix-create-acc-param
branch
from
7e18aed to
09d612b
Compare
GabrielBrascher
approved these changes
Sep 29, 2020
Member
GabrielBrascher
left a comment
GabrielBrascher
left a comment
There was a problem hiding this comment.
+1 on this API description enhancement
rohityadavcloud
approved these changes
Sep 30, 2020
| @Parameter(name = ApiConstants.ACCOUNT, | ||
| type = CommandType.STRING, | ||
| description = "Creates the user under the specified account. If no account is specified, the username will be used as the account name.") | ||
| description = "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.") |
Contributor
There was a problem hiding this comment.
Suggested change
| description = "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.") | |
| description = "Name of the account to be created. This account may not exist. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.") |
Member
|
This is just doc changes, Travis tests LGTM; merging based on this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Updating the account parameter description to let the user know that a new account will be created rather than the user being added to an existing account
Types of changes