Add vim help file

[ghost]

created vim help file for #83 . I hope everything is correct.
If I should add more things to the help file please tell me.

[blueyed]

vimhelplint reports some issues:

% VIMHELPLINT_VIM="nvim --headless" vimhelplint doc/deoplete-jedi.txt
doc/deoplete-jedi.txt:3:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:10:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:22:13:Error:2:A tag "deoplete-jedi" is duplicate with another in this file.
doc/deoplete-jedi.txt:41:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:56:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:65:41:Error:2:A tag "deoplete-jedi" is duplicate with another in this file.
doc/deoplete-jedi.txt:92:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:103:45:Error:4:A link "nvim-python-quickstart" does not have any corresponding tag.

[blueyed]

vimhelplint is from https://github.com/neomake/neomake/blob/master/contrib/vimhelplint.

With Neomake you can run :Neomake vimhelplint on the file (after make build/vimhelplint in Neomake's plugin dir).

[ghost]

I removed the error message but the warnings about the long lines are wrong.

The longest line in the file is 77 but vimhelplint still shows the warnings.

Seems the problem was with neomake.
Installed vimhelplint from https://github.com/machakann/vim-vimhelplint and warnings are gone.

[blueyed]

That does not work for me.
It seems to be provider-python in current Neovim - changed in neovim/neovim@37f560ae.

So it should be |provider-python| probably (assuming that 0.2.0 is released soonish).

[blueyed]

I do not get your last comment.
Are you saying that vimhelplint installed/used through Neomake's contrib script would get line lengths wrong?

[blueyed]

You might have been fooled by Vim's conceal feature to make *foo* into foo in help files (and therefore getting two columns less visually).

[zchee]

@blueyed Sorry for the late reply.
BTW, user is deleted account. but I think this pull request is very great work. So I want to merge, and fix your suggested point after the merge.
What do you think?

[blueyed]

@zchee
Yes, go ahead - but why not fix them by amending the commit right away then?

[zchee]

@blueyed Yeah, good idea.
But sorry... I don't have knowledge of vim help yet...😱
What meaning that warning result? #119 (comment)

[zchee]

@blueyed Ah, sorry. ghost said

I removed the error message but the warnings about the long lines are wrong.

So, now you suggested point is only of this?

You might have been fooled by Vim's conceal feature to make foo into foo in help files (and therefore getting two columns less visually).

[blueyed]

Remaining warnings are only about length:

doc/deoplete-jedi.txt:3:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:41:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:56:1:Warning:1:The width of a line should be no longer than 78.
doc/deoplete-jedi.txt:92:1:Warning:1:The width of a line should be no longer than 78.

Make sure to set conceallevel=0 when viewing those lines.

I would also use spaces instead of tabs throughout the file.

[zchee]

@blueyed

Remaining warnings are only about length:
Make sure to set conceallevel=0 when viewing those lines.

I see, Thanks. So, I should fix only of column length to less than 78, right?

I would also use spaces instead of tabs throughout the file.

got it.

BTW, Do we need magic comment such as these?
https://github.com/neomake/neomake/blob/43e6a4577aaa6e2fec0edc5ddf02180f9d574656/doc/neomake.txt#L697

[blueyed]

Not sure about the modeline ("magic line") - let's keep it.

[Shougo]

Why it is suspended?