tpope / vim-fugitive

fugitive.vim: A Git wrapper so awesome, it should be illegal
https://www.vim.org/scripts/script.php?script_id=2975
19.82k stars 1k forks source link

Fugitive help inconsistent with usage of `[]` and `{}` #2314

Closed emiel closed 3 months ago

emiel commented 3 months ago

While reading the Vim fugitive help I stumbled upon the :G and :Git commands first. See:

https://github.com/tpope/vim-fugitive/blob/4f59455d2388e113bd510e85b310d15b9228ca0d/doc/fugitive.txt#L19-L22

If :G is the same as :Git why would there be a difference between optional and required args. If my reading of https://vimhelp.org/intro.txt.html#notation is correct then [] is optional and {} means required.

I started preparing a patch but later saw [:Git (with no arguments)](https://github.com/tpope/vim-fugitive/blob/4f59455d2388e113bd510e85b310d15b9228ca0d/doc/fugitive.txt#L51) and decided to just report this here. I suggest moving this :Git (with no arguments) closer to the top (near :G and :Git) or simply combine them.

Perhaps review other usages as well.