rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

standardize placeholders in configdata descriptions

Browse Source 
* 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:
   '* `{<placeholder>}`: <description>.'
This commit is contained in:
Marcel Schilling 2017-11-03 08:48:30 +01:00
parent af9c94bd23
commit 7e07f5c996
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
qutebrowser/config/configdata.yml
View File

@ -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: