Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add documentation for ruby_fold #118

Merged
merged 4 commits into from Dec 1, 2012

Conversation

Projects
None yet
3 participants
Contributor

rolfb commented Nov 30, 2012

Added documentation for how to use the ruby_fold variable to enable folding if foldmethod is set to anything other than "syntax".

@rolfb rolfb Add documentation for ruby_fold
Added documentation for how to use the ruby_fold variable to enable folding if foldmethod is set to anything other than "syntax".
28b6498

Looks good!

One minor issue: you've included the < to close the code block, but you omitted the opening >. See :help help-writing for details.

Also, it would be nice if you included *ruby_fold*, so as to generate a helptag for that setting, which would make this feature a bit more discoverable. Although I realize that the rest of this documentation doesn't use that convention.

Typo fix: s/ruby-minlines/ruby_minlines

Contributor

rolfb commented Nov 30, 2012

There you go :)

Member

AndrewRadev commented Dec 1, 2012

Looks great. Thanks for your work :).

@AndrewRadev AndrewRadev added a commit that referenced this pull request Dec 1, 2012

@AndrewRadev AndrewRadev Merge pull request #118 from rolfb/patch-1
Add some syntax documentation
6d028f3

@AndrewRadev AndrewRadev merged commit 6d028f3 into vim-ruby:master Dec 1, 2012

Member

AndrewRadev commented Dec 1, 2012

Hmm, actually, I'm going to have to edit it a bit. The ft-ruby-syntax file is included under Vim's :help syntax section, so putting separators makes it break conventions in that file. Still, the tags and numbering of sections might be a good idea, I'll just remove the separators for now.

Contributor

rolfb commented Dec 1, 2012

Whoops. It'll be nice to see how it should look :)

  • Rolf

On 1. des. 2012, at 13:48, Andrew Radev notifications@github.com wrote:

Hmm, actually, I'm going to have to edit it a bit. The ft-ruby-syntax file
is included under Vim's :help syntax section, so putting separators makes
it break conventions in that file. Still, the tags and numbering of
sections might be a good idea, I'll just remove the separators for now.


Reply to this email directly or view it on
GitHubhttps://github.com/vim-ruby/vim-ruby/pull/118#issuecomment-10916720.

Member

AndrewRadev commented Dec 1, 2012

Well, I don't exactly know how it should look, I just noticed that it clashes a bit with what's in :help syntax :). I'm not the one who wrote the docs, so if maintainers with more knowledge of that area have an issue with it, please pitch in.

For now, I think the latest version I pushed is OK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment