docs: improve the descriptions of several bindable functions

Some functions behave differently when some lines or a region is marked.
master
Benno Schulenberg 2021-08-23 10:12:55 +02:00
parent dab3f95c71
commit c6ba4ae89a
2 changed files with 22 additions and 18 deletions

View File

@ -1414,7 +1414,8 @@ the line, column, and character positions.
(The old name of this function, 'curpos', is deprecated.) (The old name of this function, 'curpos', is deprecated.)
@item wordcount @item wordcount
Counts the number of words, lines and characters in the current buffer. Counts and reports on the status bar the number of lines, words,
and characters in the current buffer (or in the marked region).
@item execute @item execute
Prompts for a program to execute. The program's output will be inserted Prompts for a program to execute. The program's output will be inserted
@ -1432,27 +1433,28 @@ Invokes a full-buffer-processing program (if the active syntax defines one).
Invokes a syntax-checking program (if the active syntax defines one). Invokes a syntax-checking program (if the active syntax defines one).
@item justify @item justify
Justifies the current paragraph. A paragraph is a group of contiguous lines Justifies the current paragraph (or the marked region).
A paragraph is a group of contiguous lines
that, apart from possibly the first line, all have the same indentation. The that, apart from possibly the first line, all have the same indentation. The
beginning of a paragraph is detected by either this lone line with a differing beginning of a paragraph is detected by either this lone line with a differing
indentation or by a preceding blank line. indentation or by a preceding blank line.
@item fulljustify @item fulljustify
Justifies the entire current buffer. Justifies the entire current buffer (or the marked region).
@item indent @item indent
Indents (shifts to the right) the currently marked text. Indents (shifts to the right) the current line or the marked lines.
@item unindent @item unindent
Unindents (shifts to the left) the currently marked text. Unindents (shifts to the left) the current line or the marked lines.
@item comment @item comment
Comments or uncomments the current line or marked lines, using the comment Comments or uncomments the current line or the marked lines,
style specified in the active syntax. using the comment style specified in the active syntax.
@item complete @item complete
Completes the fragment before the cursor to a full word found elsewhere Completes (when possible) the fragment before the cursor
in the current buffer. to a full word found elsewhere in the current buffer.
@item left @item left
Goes left one position (in the editor or browser). Goes left one position (in the editor or browser).

View File

@ -657,7 +657,8 @@ the line, column, and character positions.
(The old name of this function, 'curpos', is deprecated.) (The old name of this function, 'curpos', is deprecated.)
.TP .TP
.B wordcount .B wordcount
Counts the number of words, lines and characters in the current buffer. Counts and reports on the status bar the number of lines, words,
and characters in the current buffer (or in the marked region).
.TP .TP
.B execute .B execute
Prompts for a program to execute. The program's output will be inserted Prompts for a program to execute. The program's output will be inserted
@ -674,27 +675,28 @@ Invokes a full-buffer-processing program (if the active syntax defines one).
Invokes a syntax-checking program (if the active syntax defines one). Invokes a syntax-checking program (if the active syntax defines one).
.TP .TP
.B justify .B justify
Justifies the current paragraph. A paragraph is a group of contiguous lines Justifies the current paragraph (or the marked region).
A paragraph is a group of contiguous lines
that, apart from possibly the first line, all have the same indentation. The that, apart from possibly the first line, all have the same indentation. The
beginning of a paragraph is detected by either this lone line with a differing beginning of a paragraph is detected by either this lone line with a differing
indentation or by a preceding blank line. indentation or by a preceding blank line.
.TP .TP
.B fulljustify .B fulljustify
Justifies the entire current buffer. Justifies the entire current buffer (or the marked region).
.TP .TP
.B indent .B indent
Indents (shifts to the right) the currently marked text. Indents (shifts to the right) the current line or the marked lines.
.TP .TP
.B unindent .B unindent
Unindents (shifts to the left) the currently marked text. Unindents (shifts to the left) the current line or the marked lines.
.TP .TP
.B comment .B comment
Comments or uncomments the current line or marked lines, using the comment Comments or uncomments the current line or the marked lines,
style specified in the active syntax. using the comment style specified in the active syntax.
.TP .TP
.B complete .B complete
Completes the fragment before the cursor to a full word found elsewhere Completes (when possible) the fragment before the cursor
in the current buffer. to a full word found elsewhere in the current buffer.
.TP .TP
.B left .B left
Goes left one position (in the editor or browser). Goes left one position (in the editor or browser).