From 7e07f5c9965e109a87c6661e8eb61a57020efa2c Mon Sep 17 00:00:00 2001 From: Marcel Schilling Date: Fri, 3 Nov 2017 08:48:30 +0100 Subject: [PATCH] standardize placeholders in configdata descriptions * Keep descriptions concise. * Prefer starting descriptions with a noun. * Don't explain that placeholders are placeholders/get replaced. * Introduce placeholder list by the following line: 'The following placeholders are defined:' * List placeholders in a markdown-style list: '* `{}`: .' --- qutebrowser/config/configdata.yml | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml index 48c7ce294..4a73822e4 100644 --- a/qutebrowser/config/configdata.yml +++ b/qutebrowser/config/configdata.yml @@ -775,19 +775,13 @@ editor.command: default: ["gvim", "-f", "{file}", "-c", "normal {line}G{column0}l"] desc: >- Editor (and arguments) to use for the `open-editor` command. + The following placeholders are defined: - Several placeholders are supported. Placeholders are substituted by the - respective value when executing the command. - - `{file}` gets replaced by the filename of the file to be edited. - - `{line}` gets replaced by the line in which the caret is found in the text. - - `{column}` gets replaced by the column in which the caret is found in the text. - - `{line0}` same as `{line}`, but starting from index 0. - - `{column0}` same as `{column}`, but starting from index 0. + * `{file}`: Filename of the file to be edited. + * `{line}`: Line in which the caret is found in the text. + * `{column}`: Column in which the caret is found in the text. + * `{line0}`: Same as `{line}`, but starting from index 0. + * `{column0}`: Same as `{column}`, but starting from index 0. editor.encoding: