Re: [dev] [dvtm] Commands document, one page PDF

From: Marc André Tanner <>
Date: Wed, 7 Oct 2015 21:51:01 +0200

Hi Ross,

Thanks for your work! I agree that the documentation could be improved.
A couple of comments regarding the content of your document:

 - The command column doesn't seem that useful for an end user.
   It might be better to add source code comments to the corresponding
   function prototypes in dvtm.c explaining what the function does
   and what kind of arguments it expects.

 - CTRL-G should be replaced by $MOD

The document itself should be generated from a plain text format,
be it Markdown, troff, LaTeX or something else. The source file
should also be maintained in the git repository.

Another idea would be to add a built in "help system" similar to
the way it was done in the latest vis commits where :help prints
the currently active key bindings alongside a short description.

This would have the advantage that it always matches the active
key bindings. Might be a bit overkill though ...


 Marc André Tanner >< >< GPG key: CF7D56C0
Received on Wed Oct 07 2015 - 21:51:01 CEST

This archive was generated by hypermail 2.3.0 : Wed Oct 07 2015 - 22:00:11 CEST