From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#48058: tab-width's docstring Date: Fri, 30 Apr 2021 10:18:43 +0300 Message-ID: <83eeescka4.fsf@gnu.org> References: <87a6pj50u6.fsf@gmail.com> <83eeevj0kt.fsf@gnu.org> <87wnsnkcz1.fsf@gmail.com> <8335vbixea.fsf@gnu.org> <87tunrkbdi.fsf@gmail.com> <83y2d3hhfe.fsf@gnu.org> <83pmydc7u6.fsf@gnu.org> <874kfo26gt.fsf@gmail.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="13507"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 48058@debbugs.gnu.org, gusbrs.2016@gmail.com To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Apr 30 09:21:27 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lcNSp-0003QI-4U for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 30 Apr 2021 09:21:27 +0200 Original-Received: from localhost ([::1]:56132 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lcNSo-0001wg-5Z for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 30 Apr 2021 03:21:26 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53638) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lcNRS-0000CO-0c for bug-gnu-emacs@gnu.org; Fri, 30 Apr 2021 03:20:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:45830) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lcNRR-0004Gz-P8 for bug-gnu-emacs@gnu.org; Fri, 30 Apr 2021 03:20:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lcNRR-0003iP-JY for bug-gnu-emacs@gnu.org; Fri, 30 Apr 2021 03:20:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 30 Apr 2021 07:20:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48058 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 48058-submit@debbugs.gnu.org id=B48058.161976714314191 (code B ref 48058); Fri, 30 Apr 2021 07:20:01 +0000 Original-Received: (at 48058) by debbugs.gnu.org; 30 Apr 2021 07:19:03 +0000 Original-Received: from localhost ([127.0.0.1]:57370 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lcNQV-0003go-Ao for submit@debbugs.gnu.org; Fri, 30 Apr 2021 03:19:03 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:45102) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lcNQS-0003gK-Bd for 48058@debbugs.gnu.org; Fri, 30 Apr 2021 03:19:02 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:58335) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lcNQM-0003bp-ID; Fri, 30 Apr 2021 03:18:54 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2619 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1lcNQK-0000Tb-FW; Fri, 30 Apr 2021 03:18:54 -0400 In-Reply-To: (message from Stefan Kangas on Thu, 29 Apr 2021 17:53:27 -0500) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:205227 Archived-At: > From: Stefan Kangas > Date: Thu, 29 Apr 2021 17:53:27 -0500 > Cc: 48058@debbugs.gnu.org > > 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]. */); I don't think the user will find anything about this in the documentation of the major mode. Did you see anything useful about this in the doc string of any major mode or in what "C-h m" displays for that mode? I tried two very popular modes (ELisp and C) and didn't see anything pertinent. I propose the following text instead: Distance between tab stops (for display of tab characters), in columns. This controls the width of a TAB character on display. The value should be a positive integer. Note that this variable doesn't necessarily affect the size of the indentation step, but if the major mode's indentation facility inserts one or more TAB characters, this variable will affect the indentation step as well, even if `indent-tabs-mode' is non-nil.