-
Notifications
You must be signed in to change notification settings - Fork 904
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prefer long flags in quick start example #1029
Conversation
`--detach` is clearer (to a new Docker user) than `-d`. Similarly `--volume` is clearer than `-v`. Motivation: https://changelog.com/posts/use-long-flags-when-scripting Referred to: https://docs.docker.com/engine/reference/commandline/run/
Codecov Report
@@ Coverage Diff @@
## main #1029 +/- ##
=======================================
Coverage 59.63% 59.63%
=======================================
Files 22 22
Lines 1412 1412
=======================================
Hits 842 842
Misses 500 500
Partials 70 70 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. It's clearer what every argument is doing, and if you already know what they do you probably also know the short hands (or you look them up if you care enough about make your commands shorter 😁)
I disagree here. All the docker examples I was finding and following on the internet when I was learning docker were ALWAYS using |
@zoispag Indeed. That's probably why they were used in the docs in the first place. I think the main problem is with people who just copy commands from the docs and try to modify them to suite their needs. |
Agreed. I was similarly confused by this naming conflict. I think the longer format flags remove the risk of confusion. |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
--detach
is clearer (to a new Docker user) than-d
. Similarly--volume
is clearer than-v
.Motivation: https://changelog.com/posts/use-long-flags-when-scripting
Referred to: https://docs.docker.com/engine/reference/commandline/run/