unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 48058@debbugs.gnu.org, gusbrs.2016@gmail.com
Subject: bug#48058: tab-width's docstring
Date: Fri, 30 Apr 2021 10:18:43 +0300	[thread overview]
Message-ID: <83eeescka4.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmkwiSXt1Wnt74qTxbaraSjM1Y8d9PyFOdsU2Cr17cU9wA@mail.gmail.com> (message from Stefan Kangas on Thu, 29 Apr 2021 17:53:27 -0500)

> From: Stefan Kangas <stefan@marxist.se>
> 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.





  parent reply	other threads:[~2021-04-30  7:18 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-27 13:11 bug#48058: tab-width's docstring Gustavo Barros
2021-04-27 13:53 ` Eli Zaretskii
2021-04-27 14:40   ` Gustavo Barros
2021-04-27 15:02     ` Eli Zaretskii
2021-04-27 15:14       ` Gustavo Barros
2021-04-27 15:32         ` Eli Zaretskii
2021-04-29 17:05           ` Stefan Kangas
2021-04-29 17:35             ` Eli Zaretskii
2021-04-29 20:14               ` Gustavo Barros
2021-04-29 22:53                 ` Stefan Kangas
2021-04-30  0:44                   ` Gustavo Barros
2021-04-30  7:18                   ` Eli Zaretskii [this message]
2021-04-30 10:20                     ` Stefan Kangas
2021-04-30 10:49                       ` Eli Zaretskii
2021-04-30 12:00                         ` Gustavo Barros

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83eeescka4.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=48058@debbugs.gnu.org \
    --cc=gusbrs.2016@gmail.com \
    --cc=stefan@marxist.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).