search

idanarye / vim-omnipytent

The all powerful Pythonic task runner
http://www.vim.org/scripts/script.php?script_id=5432
10 stars 0 forks source link

Improve documentation for configuration #10

Closed lervag closed 5 years ago

lervag commented 5 years ago

The options are not all documented properly. Some issues are:

  1. The options should be documented consistently in the "CONFIGURATION" section. Right now, only the "g:omnipytent_filePrefix" option is properly documented.
  2. The "g:omnipytent_selectionUI" option is not described at all.
idanarye commented 5 years ago

I do want to keep the full description of each configuration option in the section where it makes most sense. I put the g:omnipytent_filePrefix in there because it is something you must set before you can use Omnipytent, and the others are linked to the relevant section...

But maybe it would be clearer and more consistent if I add a BEFORE YOU BEGIN section for the g:omnipytent_filePrefix and make all the entries under CONFIGURATION into links to the proper place + short description?

idanarye commented 5 years ago

Even better - I move the g:omnipytent_filePrefix description to the CREATING TASKS section and refer the user to this section in the INTRODUCTION.

lervag commented 5 years ago

Great, I agree this works well.