-
Notifications
You must be signed in to change notification settings - Fork 148
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
Better wording for 'part' #11
Comments
First: Thank you for writing this down, especially usability problems like this are hard to come by because I can't look every user over the shoulder and hear them thinking! About: In the standard configuration, a part is "one of You're right "part" may be an unfortunate name, and it's very well up for discussion. "level" might be better, but I don't think that's to the point. Why is it so hard finding a name for this ? About your suggestion making "part" optional: That was the default behavior in bumpversion < 0.3, and I made it so because bumping versions is something explicit that you do conciously and I want users to make an explicit choice which part of the version should be bumped. |
Closing this until someone (maybe me?) comes up with a better name. I'm very open to suggestions! |
When trying out bumpversion for the first time, I found the error message to be distinctly unhelpful
Which arguments does it want?
Oh, I see, buried in the middle of that verbiage the word "part" is not surrounded by brackets, nor preceded by dashes. Guess it must be looking for a "part" then. So, why didn't it say that, instead of arguments?
Anyway, what's a "part"? Lets try the help
Not very helpful! Guess I'll have to leave out the grep then.
Even more verbiage, in the middle of which is
Not exactly the most helpful help ever. In fact, given that the command is called "bumpversion" and the missing argument is called "part" I would opine that "Part of the version to be bumped" actually says nothing at all.
OK, let's try the website, where we find
But I didn't use the --serialize / --parse option. And they are "options", so I don't have to use them. What's the default?
Further down on the web page we find
--serialize / serialize =
Not sure what syntax that is - does that mean I have to use 3 parts, or 3 parts to make one part, or that I can change it to use 3 parts, or ..., or what?
All told - that is such an obscure way of saying what the basic way of using the command is as to be grossly unhelpful.
I would suggest that the usage message should mention "parts", not "arguments". And the default allowable arguments of major/minor/patch should be mentioned in the usage message. They should also be, at least, available for reading on the command line, not just on the website.
Finally, and less obviously, I would suggest that part be made optional, and the simplest avaialble command should be
which should bump the patch level
The text was updated successfully, but these errors were encountered: