Hi Arnaud! On Mi, 29 Jul 2015, Arnaud Decara wrote:
> Hello list, > > Would you be interested in a rewriting of the > options.txt help file (actually only the first > part "1. Setting options") ? > > I think that the way it is currently written makes > it harder to understand than it should be. When > you understand it correctly, the option system > has actually a really simple logic which, in my > opinion, should be explained more "systematically" > (by regrouping the similar pieces of information, > and allowing the user to get the big picture). > > In my opinion: > It should start with a description (~ 50 lines) > of the five categories of options depending on > their scope (global, buf and win local, buf and > win global-local). > I might be able to improve the explanation for > local variables of window local and window > global-local options (by emphasizing the fact that > they are not really local to a window but to a > pair constituted of a window and a buffer). > I could also emphasize clearly the practical > differences between local and global-local > options. > > Then it should explain more rigorously and in one > unique place (!) what are the actual differences > between :set, :setlocal and :setglobal. > For a given argument they are doing exactly the > same thing but not on the same variables. > It is currently quite well explained, except for > the particular behaviour of :set with local and > globall-local options (which is the only > non-straightforward thing to explain). The > explanation of :setlocal could also be simplified. > > Finally it should simply present the arguments of > :set, :setlocal and :setglobal. > > What do you think? I always thought that the documentation of setglobal and setlocal and set together with global/local and global-local options could be improved. I often have to reread that part of the documentation and still feel I don't understand it fully. So feel free to suggest a documentation improvement. I don't think, Bram would have something against an improvement. Best, Christian -- Wenn man sich selber trifft ist man entweder in einer Zeitschleife oder vor dem Spiegel. -- -- You received this message from the "vim_dev" maillist. Do not top-post! Type your reply below the text you are replying to. For more information, visit http://www.vim.org/maillist.php --- You received this message because you are subscribed to the Google Groups "vim_dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
