summaryrefslogtreecommitdiff
path: root/test/regression/860-python-incorrect-commenting/cmd
diff options
context:
space:
mode:
authorFrank LENORMAND <lenormf@gmail.com>2016-10-11 10:03:41 +0300
committerFrank LENORMAND <lenormf@gmail.com>2016-10-11 10:26:17 +0300
commitf6a2925950baa85d6b3835e6f418bbecd11a9295 (patch)
treea9771b20cb73a121311607ee09668399875b3e12 /test/regression/860-python-incorrect-commenting/cmd
parent5440d31f995d9143e4f14a343a41aaab227ffbad (diff)
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`)
Diffstat (limited to 'test/regression/860-python-incorrect-commenting/cmd')
0 files changed, 0 insertions, 0 deletions