Skip to content
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

Doc cleanup #987

Merged
merged 7 commits into from
Aug 2, 2016
Merged

Doc cleanup #987

merged 7 commits into from
Aug 2, 2016

Conversation

arp242
Copy link
Contributor

@arp242 arp242 commented Aug 1, 2016

  • This merges @svanburen 's PR Cleanup documentation formatting #935 − resolving the conflicts.
  • Sync "troubleshooting" section with the one on the Wiki. IMHO we're probably best off deleting the wiki page after this is merged?
  • Mention Vim's packages feature for installing.
  • Run vimhelplint and fix all the reported errors. Many are boring line width changes, but there were also quite a few "missing link" errors (e.g. |g:go_foo| instead of |'g:go_foo'| was used).
  • Add a few settings that were undocumented.
  • Fix a few minor typos.

@@ -75,6 +75,8 @@ command.
* `NeoBundle 'fatih/vim-go'`
* [Vundle](https://github.com/gmarik/vundle)
* `Plugin 'fatih/vim-go'`
* [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528)
* `git clone https://github.com/fatih/vim-go.git ~/.vim/pack/plugins/start/vim-go`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does git create the directory if it doesn't exist? (didn't tested it just asking here lazily :))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah:

[~]% ls ~/cocunuts
/home/martin/coconuts: No such file or directory.

[~]% git clone git@github.com:machakann/vim-vimhelplint.git ~/coconuts/with/bananes/are/nice/
Cloning into '/home/martin/coconuts/with/bananes/are/nice'...
remote: Counting objects: 100, done.
remote: Total 100 (delta 0), reused 0 (delta 0), pack-reused 100
Receiving objects: 100% (100/100), 21.79 KiB | 0 bytes/s, done.
Resolving deltas: 100% (27/27), done.
Checking connectivity... done.

[~]% ls ~/coconuts/with/bananes/are/nice/
/home/martin/coconuts/with/bananes/are/nice:
doc/             ftplugin/        README.md        syntax_checkers/ 

@fatih fatih merged commit 49f4e2a into fatih:master Aug 2, 2016
@fatih
Copy link
Owner

fatih commented Aug 2, 2016

Thanks @Carpetsmoker @svanburen

@arp242 arp242 deleted the doc-cleanup branch August 2, 2016 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants