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

Add vim help about vim-polyglot #501

Closed
jrwrigh opened this issue Jun 16, 2020 · 3 comments
Closed

Add vim help about vim-polyglot #501

jrwrigh opened this issue Jun 16, 2020 · 3 comments

Comments

@jrwrigh
Copy link

jrwrigh commented Jun 16, 2020

~7 years ago, there was a request to add documentation to the plugin in #9. The main reason to not due that was the lack of documentation for syntax files and that most of documentation that exists documented functionality within a plugin directory.

Correct me if I'm wrong, but I'd say things have changed a decent bit in 7 years. This plugin is no longer limited to just the syntax files and even then many syntax files have associated options with them. I think it'd be a good idea to start incorporating the documentation into this plugin. Thoughts?

@sheerun
Copy link
Owner

sheerun commented Jun 16, 2020

Vim-polygot strips plugin directory from plugins and imports just syntax and indentation

@sheerun
Copy link
Owner

sheerun commented Jun 16, 2020

Also there's point in having no documentation even if there are some functions available by mistake - vim-polyglot is not meant to be used as something that can be configured. In principle it should just add syntax, indentation, maybe some language-related options and that's it. I don't want to add documentation because I don't want to give any assurances about these options. I can replace any plugin at any time, the only thing that's for sure is syntax and indentation :)

@sheerun
Copy link
Owner

sheerun commented Jun 16, 2020

Maybe we could consider adding some documentation about vim-polyglot itself like g:polyglot_disabled option and credits like in readme

@sheerun sheerun changed the title Rehash: Add documentation from subplugins Add vim help about vim-polyglot Jun 16, 2020
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

No branches or pull requests

2 participants