-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Confusing syntax in README #281
Comments
Thats trying to say that |
Ah, that seems obvious now, but hindsight is 20/20. Putting them on separate lines would be the least confusing but also takes up most space, e.g.
Or on the same line but separated, e.g.
Or hinting at alternative behaviour, e.g.
And so forth for all commands that have a secondary option. |
If the information has to stay on one line (@gmarik once noted he likes the example vimrc to be short) I vote for square brackets because that's what the vim help and man pages use for optional stuff. |
It's only confusing if the user does not know Vim commands at all. It is a well known thing that many Vim commands use the exclamation mark at the end to modify their behaviour, normally the more destructive option of the command. So yes, we can split the lines, although most would have repeated text, but come on. |
That's a bit of a hyperbole. At the time I opened this issue, I've happily been using Vim for a while without ever having come across the bang (!) syntax. I'm sure there are many more who fall into the same boat. |
+1 I am using Vim/Ruby for more than 5 years and still I didn't get it with a first read! So, I agree with dideler, the documentation should clearly indicate what is going on. |
So what's your version on how documentation should look like? |
I am happy with separate lines
thanx |
Ok, let's have a PR, then. I'll merge it. |
- closes VundleVim#281
- closes VundleVim#281
A few of the commands in the README contain confusing syntax. I'm not familiar with
(!)
, what does it mean? For example, if I want to update my bundles, it's unclear if I should run:BundleInstall
or:BundleInstall(!)
-- I assume it's the former because I don't believe the latter is a valid command. Still, it's confusing.The text was updated successfully, but these errors were encountered: