From 522b4588df225d6e825c2ce3c3d81144bd7e3bff Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Fri, 30 Apr 2021 00:38:42 +0200 Subject: [PATCH] Clarify docstring of tab-width variable * src/buffer.c (syms_of_buffer) : Doc fix; clarify that this variable is used by some (but not all) major modes to control an indentation step. (Bug#48058) --- src/buffer.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/buffer.c b/src/buffer.c index 8e33162989..0540ebf034 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -5666,9 +5666,12 @@ syms_of_buffer (void) DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width), Qintegerp, doc: /* Distance between tab stops (for display of tab characters), in columns. -NOTE: This controls the display width of a TAB character, and not -the size of an indentation step. -This should be an integer greater than zero. */); +This controls the display width of a TAB character and should be an +integer greater than zero. + +In some major modes, this is also used to control the size of an +indentation step. However, this is not always the case. See the +major mode documentation for the exact details \\[describe-mode]. */); DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil, doc: /* Non-nil means display control chars with uparrow. -- 2.30.2