rc: Make docstrings more readable

This cosmetics commit makes use of the auto-deindentation syntax,
available to docstrings.
This commit is contained in:
Frank LENORMAND 2020-02-03 20:53:28 +01:00
parent 2749093143
commit 275abb227e
11 changed files with 72 additions and 40 deletions

View File

@ -370,11 +370,12 @@ evaluate-commands %sh{
"
}
declare-option -docstring %{control the type of include guard to be inserted in empty headers
declare-option -docstring %{
control the type of include guard to be inserted in empty headers
Can be one of the following:
ifdef: old style ifndef/define guard
pragma: newer type of guard using "pragma once"} \
str c_include_guard_style "ifdef"
pragma: newer type of guard using "pragma once"
} str c_include_guard_style "ifdef"
define-command -hidden c-family-insert-include-guards %{
evaluate-commands %sh{

View File

@ -217,8 +217,10 @@ define-command -hidden clojure-indent-on-new-line %{
}
}
declare-option -docstring %{top-level directories which can contain clojure files
e.g. '(src|test|dev)'} regex clojure_source_directories '(src|test|dev)'
declare-option -docstring %{
top-level directories which can contain clojure files
e.g. '(src|test|dev)'
} regex clojure_source_directories '(src|test|dev)'
define-command -docstring %{clojure-insert-ns: Insert namespace directive at top of Clojure source file} \
clojure-insert-ns %{

View File

@ -1,12 +1,14 @@
declare-option -docstring "maximum amount of characters per line, after which a newline character will be inserted" \
int autowrap_column 80
declare-option -docstring %{when enabled, paragraph formatting will reformat the whole paragraph in which characters are being inserted
This can potentially break formatting of documents containing markup (e.g. markdown)} \
bool autowrap_format_paragraph no
declare-option -docstring %{command to which the paragraphs to wrap will be passed
all occurences of '%c' are replaced with `autowrap_column`} \
str autowrap_fmtcmd 'fold -s -w %c'
declare-option -docstring %{
when enabled, paragraph formatting will reformat the whole paragraph in which characters are being inserted
This can potentially break formatting of documents containing markup (e.g. markdown)
} bool autowrap_format_paragraph no
declare-option -docstring %{
command to which the paragraphs to wrap will be passed
all occurences of '%c' are replaced with `autowrap_column`
} str autowrap_fmtcmd 'fold -s -w %c'
define-command -hidden autowrap-cursor %{ evaluate-commands -save-regs '/"|^@m' %{
try %{

View File

@ -15,9 +15,10 @@ declare-option -hidden line-specs clang_flags
declare-option -hidden line-specs clang_errors
define-command -params ..1 \
-docstring %{Parse the contents of the current buffer
The syntaxic errors detected during parsing are shown when auto-diagnostics are enabled} \
clang-parse %{
-docstring %{
Parse the contents of the current buffer
The syntaxic errors detected during parsing are shown when auto-diagnostics are enabled
} clang-parse %{
evaluate-commands %sh{
dir=$(mktemp -d "${TMPDIR:-/tmp}"/kak-clang.XXXXXXXX)
mkfifo ${dir}/fifo

View File

@ -147,8 +147,10 @@ define-command -params 1..2 \
fi
fi
} \
doc -docstring %{doc <topic> [<keyword>]: open a buffer containing documentation about a given topic
An optional keyword argument can be passed to the function, which will be automatically selected in the documentation} %{
doc -docstring %{
doc <topic> [<keyword>]: open a buffer containing documentation about a given topic
An optional keyword argument can be passed to the function, which will be automatically selected in the documentation
} %{
evaluate-commands %sh{
readonly page="${kak_runtime}/doc/${1}.asciidoc"
if [ -f "${page}" ]; then

View File

@ -22,10 +22,27 @@ declare-option -hidden line-specs git_diff_flags
declare-option -hidden int-list git_hunk_list
define-command -params 1.. \
-docstring %sh{printf 'git [<arguments>]: git wrapping helper
-docstring %{
git [<arguments>]: git wrapping helper
All the optional arguments are forwarded to the git utility
Available commands:\n add\n rm\n blame\n commit\n checkout\n diff\n hide-blame\n hide-diff\n init\n log\n next-hunk\n previous-hunk\n show\n show-diff\n status\n update-diff'} \
-shell-script-candidates %{
Available commands:
add
rm
blame
commit
checkout
diff
hide-blame
hide-diff
init
log
next-hunk
previous-hunk
show
show-diff
status
update-diff
} -shell-script-candidates %{
if [ $kak_token_to_complete -eq 0 ]; then
printf "add\nrm\nblame\ncommit\ncheckout\ndiff\nhide-blame\nhide-diff\nlog\nnext-hunk\nprev-hunk\nshow\nshow-diff\ninit\nstatus\nupdate-diff\n"
else

View File

@ -1,7 +1,8 @@
declare-option -docstring %{shell command to which the path of a copy of the current buffer will be passed
declare-option -docstring %{
shell command to which the path of a copy of the current buffer will be passed
The output returned by this command is expected to comply with the following format:
{filename}:{line}:{column}: {kind}: {message}} \
str lintcmd
{filename}:{line}:{column}: {kind}: {message}
} str lintcmd
declare-option -hidden line-specs lint_flags
declare-option -hidden range-specs lint_errors

View File

@ -8,9 +8,10 @@ declare-option -docstring "name of the client in which utilities display informa
declare-option -hidden int make_current_error_line
define-command -params .. \
-docstring %{make [<arguments>]: make utility wrapper
All the optional arguments are forwarded to the make utility} \
make %{ evaluate-commands %sh{
-docstring %{
make [<arguments>]: make utility wrapper
All the optional arguments are forwarded to the make utility
} make %{ evaluate-commands %sh{
output=$(mktemp -d "${TMPDIR:-/tmp}"/kak-make.XXXXXXXX)/fifo
mkfifo ${output}
( eval ${kak_opt_makecmd} "$@" > ${output} 2>&1 & ) > /dev/null 2>&1 < /dev/null

View File

@ -57,10 +57,11 @@ define-command -params ..1 \
-shell-script-candidates %{
find /usr/share/man/ -name '*.[1-8]*' | sed 's,^.*/\(.*\)\.\([1-8][a-zA-Z]*\).*$,\1(\2),'
} \
-docstring %{man [<page>]: manpage viewer wrapper
-docstring %{
man [<page>]: manpage viewer wrapper
If no argument is passed to the command, the selection will be used as page
The page can be a word, or a word directly followed by a section number between parenthesis, e.g. kak(1)} \
man %{ evaluate-commands %sh{
The page can be a word, or a word directly followed by a section number between parenthesis, e.g. kak(1)
} man %{ evaluate-commands %sh{
subject=${1-$kak_selection}
## The completion suggestions display the page number, strip them if present

View File

@ -36,8 +36,10 @@ define-command tmux-repl-window -params 0..1 -command-completion -docstring "Cre
tmux-repl-impl 'new-window' %arg{@}
}
define-command -hidden tmux-send-text -params 0..1 -docstring "tmux-send-text [text]: Send text(append new line) to the REPL pane.
If no text is passed, then the selection is used" %{
define-command -hidden tmux-send-text -params 0..1 -docstring %{
tmux-send-text [text]: Send text(append new line) to the REPL pane.
If no text is passed, then the selection is used
} %{
nop %sh{
if [ $# -eq 0 ]; then
tmux set-buffer -b kak_selection "${kak_selection}"

View File

@ -5,8 +5,10 @@ hook global ModuleLoaded x11 %{
provide-module x11-repl %{
# termcmd should already be set in x11.kak
define-command -docstring %{x11-repl [<arguments>]: create a new window for repl interaction
All optional parameters are forwarded to the new window} \
define-command -docstring %{
x11-repl [<arguments>]: create a new window for repl interaction
All optional parameters are forwarded to the new window
} \
-params .. \
-shell-completion \
x11-repl %{ evaluate-commands %sh{