Change to plural forms for help output of docker service update
#28147
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
yongtang
force-pushed
the
27567-service-update-docs-plural-form
branch
from
d873531
to
febfb7a
Compare
|
cc @mstanleyjones |
|
Oh! Hm, I actually think the singular form is clearer, because each |
This fix is based on the comment in moby#27567 (comment) Basically, in the help output of `docker service update`, the `--xxx-add` flags typically have plural forms while `--xxx-rm` flags have singular forms. This fix updates the help output for consistency. This fix also updates the related docs in `service_update.md`. The help output in `service_update.md` has been quite out-of-sync with the actual output so this fix replaces the output with the most up-to-date output. This fix is related to moby#27567. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
yongtang
force-pushed
the
27567-service-update-docs-plural-form
branch
from
febfb7a
to
1b42d9d
Compare
|
@thaJeztah Changed to singular form with consistency 😅 |
thaJeztah
reviewed
Nov 8, 2016
| --restart-max-attempts uint64-ptr Maximum number of restarts before giving up (default none) | ||
| --restart-window duration-ptr Window used to evaluate the restart policy (default none) | ||
| --rollback Rollback to previous specification | ||
| --stop-grace-period duration-ptr Time to wait before force killing a container (default none) |
There was a problem hiding this comment.
Not for this PR, but we should change the output to be a bit more useful; duration-ptr is the internal implementation, and not very informative for the end-user.
There was a problem hiding this comment.
The duration-ptr and uint64-ptr are defined in the Type() of the DurationOpt and Uint64Opt. I think -ptr could be removed as the purpose is to have nil as the default value.
There was a problem hiding this comment.
@thaJeztah I added a PR #28163 for -ptr. Please take a look.
|
@thaJeztah is the |
|
Let me restart janky |
yongtang
added a commit
to yongtang/docker
that referenced
this pull request
Nov 9, 2016
This fix is based on the comment: moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to moby#28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
dnephin
pushed a commit
to dnephin/docker
that referenced
this pull request
Apr 17, 2017
…-plural-form Change to plural forms for help output of `docker service update`
vdemeester
pushed a commit
to vdemeester/docker-cli
that referenced
this pull request
May 15, 2017
This fix is based on the comment: moby/moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to #28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
andrewhsu
pushed a commit
to docker-archive/docker-ce
that referenced
this pull request
May 19, 2017
This fix is based on the comment: moby/moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to #28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com> Upstream-commit: 071c746e5ef5e407d6769a0fd436e8cf50b371a9 Component: cli
andrewhsu
pushed a commit
to docker-archive/docker-ce
that referenced
this pull request
May 19, 2017
This fix is based on the comment: moby/moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to #28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com> Upstream-commit: 583dd837278ab8999a45ba9be109f706d57485ae Component: cli
andrewhsu
pushed a commit
to docker-archive/docker-ce
that referenced
this pull request
Jun 5, 2017
This fix is based on the comment: moby/moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to #28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com> Upstream-commit: ac4b6e35056b8a99993919411421e5a5fb2f30e9 Component: cli
dnephin
pushed a commit
to dnephin/cli
that referenced
this pull request
Jun 14, 2017
This fix is based on the comment: moby/moby#28147 (comment) Previously the output string of the `DurationOpt` is `duration-ptr` and `Uint64Opt` is `uint64-ptr`. While it is clear to developers, for a normal user `-ptr` might not be very informative. On the other hand, the default value of `DurationOpt` and `Uint64Opt` has already been quite informative: `none`. That means if no flag provided, the value will be treated as none. (like a ptr with nil as the default) For that reason this fix removes the `-ptr`. Also, the output in the docs of `service create` has been quite out-of-sync with the true output. So this fix updates the docs to have the most up-to-date help output of `service create --help`. This fix is related to #28147. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
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.
This fix is based on the comment in
#27567 (comment)
Basically, in the help output of
docker service update, the--xxx-addflags typically have plural forms while--xxx-rmflags have singular forms.This fix updates the help output for consistency.
This fix also updates the related docs in
service_update.md.The help output in
service_update.mdhas been quite out-of-sync with the actual output, so this fix replaces the output with the most up-to-date output.This fix is related to #27567.
cc @aaronlehmann
Signed-off-by: Yong Tang yong.tang.github@outlook.com