Documentation improvements for 'display-line-numbers'

* doc/emacs/display.texi (Display Custom): Document a few more
options for display-line-numbers.  (Bug#28533)  Fix a typo.
This commit is contained in:
Eli Zaretskii 2017-09-23 10:07:11 +03:00
parent f656ccdb43
commit 0e143b1fc5

View file

@ -1756,7 +1756,7 @@ Any other non-@code{nil} value is treated as @code{t}.
@vindex display-line-numbers-type @vindex display-line-numbers-type
A convenient way of turning on display of line numbers is @w{@kbd{M-x A convenient way of turning on display of line numbers is @w{@kbd{M-x
display-line-numbers-mode @key{RET}}}. This mode has a globalized display-line-numbers-mode @key{RET}}}. This mode has a globalized
variant, @code{global-display-line0numbers-mode}. The user option variant, @code{global-display-line-numbers-mode}. The user option
@code{display-line-numbers-type} controls which sub-mode of @code{display-line-numbers-type} controls which sub-mode of
line-number display, described above, will these modes activate. line-number display, described above, will these modes activate.
@ -1778,6 +1778,17 @@ the variable @code{display-line-numbers-widen} to a non-@code{nil}
value, line numbers will disregard any narrowing and will start at the value, line numbers will disregard any narrowing and will start at the
first character of the buffer. first character of the buffer.
@vindex display-line-numbers-width-start
@vindex display-line-numbers-grow-only
@vindex display-line-numbers-width
In selective display mode (@pxref{Selective Display}), and other modes
that hide many lines from display (such as Outline and Org modes), you
may wish to customize the variables
@code{display-line-numbers-width-start} and
@code{display-line-numbers-grow-only}, or set
@code{display-line-numbers-width} to a large enough value, to avoid
occasional miscalculations of space reserved for the line numbers.
@cindex line-number face @cindex line-number face
The line numbers are displayed in a special face @code{line-number}. The line numbers are displayed in a special face @code{line-number}.
The current line number is displayed in a different face, The current line number is displayed in a different face,