search

ap / vim-css-color

Preview colours in source code while editing
http://www.vim.org/scripts/script.php?script_id=5056
MIT License
1.79k stars 80 forks source link

ADD README.md documentation on usage #116

Closed nicolnt closed 4 years ago

nicolnt commented 5 years ago

Adding usage notes for the functions I couldn't figure out what css_color#init(type, keywords, groups) does! This is my first ever pull request, please tell me if I'm doing anything wrong :smile_cat:

ap commented 4 years ago

Whoa sorry. This got buried in my inbox.

Your PR is fine and appreciated.

The bad news is I’m not going to take this patch, I’m afraid. Sorry about your first PR. 🙁 The README is not a good place for this information because it is visible only on GitHub, not inside Vim. The information would be inaccessible after installing the plugin. The right place for it is in a proper Vimdoc page that can be accessed using :help.

You can see an example of what that would look like in the doc/buftabline.txt for my Buftabline plugin. I filed #80 as a reminder to make such a page for this plugin, though I still haven’t gotten around to it after years because of blank page syndrom vs my fairly picky tastes about a good, useful, comprehensive yet concise Vimdoc page that matches Vimdoc style…

At the very least, thank for you the reminder that I should get around to that. If I still haven’t done it myself by the time you see this reply, and you wouldn’t mind going a few rounds with me until the page looks good to me, I would be grateful if you wish to tackle it.

nicolnt commented 4 years ago

I definitely agree with you about making a proper Vimdoc for this plugin. However showing some simplified information about its features in the README.md would really help people like me who tend to check these on GitHub beforehand. It should be super simple yet informative. For instance, the following README.md helped me pick this plugin because I knew what it could do with it exactly: https://github.com/sakhnik/nvim-gdb#usage

No worries about the delay, and I'll try to start writing docs if I can find some free time. I've never wrote any VimDoc but I'm happy to learn 😁