kakoune/rc/extra
Frank LENORMAND f6a2925950 Fix, complete and add docstring documentation to builtin commands
Level out the builtin commands loaded at startup in terms of format and
expressiveness. The following convention was followed:
* commands that take more than one argument have to be described along
  with their parameters prior to the actual documentation, otherwise the
  docstring consists in a capitalized sentence
  e.g. `command <arg1>: do something`
* optional arguments are enclosed in square brackets, to comply with the
  format used for hardcoded commands
  e.g. `cd [<directory>]`
* describe the effects of the command in the documentation string and
  omit implementation details unless they are relevant. Usually command
  names include the name of the tool they use, so they don't need to be
  redundantly mentioned
  e.g. `tmux-new-pane <arguments>: open a new pane`
* document the format the parameters to the commands, or list them if
  they are to be chosen among a list of static values (c.f. `spell.kak`)
2016-10-11 10:26:17 +03:00
..
autorestore.kak autorestore.kak: more tweaks, a WIP version was pushed by error 2016-10-07 08:57:45 +01:00
cabal.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
clang.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
coffee.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
cucumber.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
dockerfile.kak Add highlight group to highlighters rmhl hooks 2016-09-28 08:45:01 +02:00
editorconfig.kak Pass a generic pattern to printf calls, use echo when possible 2016-04-23 10:00:36 +03:00
exherbo.kak Add highlight group to highlighters rmhl hooks 2016-09-28 08:45:01 +02:00
flake8.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
git-tools.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
haml.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
iterm.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
jedi.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
kickstart.kak Add highlight group to highlighters rmhl hooks 2016-09-28 08:45:01 +02:00
latex.kak Add highlight group to highlighters rmhl hooks 2016-09-28 08:45:01 +02:00
modeline.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
moon.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
pug.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
ragel.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
ranger.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
sass.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
scss.kak Fix hool -> hook in rc files 2016-10-01 14:09:59 +01:00
tmux-repl.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00
tupfile.kak Add highlight group to highlighters rmhl hooks 2016-09-28 08:45:01 +02:00
x11-repl.kak Fix, complete and add docstring documentation to builtin commands 2016-10-11 10:26:17 +03:00