unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: 50731@debbugs.gnu.org
Subject: bug#50731: `progress-reporter-update' docstring and `backward-sexp' interaction
Date: Tue, 21 Sep 2021 23:52:58 -0700	[thread overview]
Message-ID: <CADwFkmnpQRGnGAvn8mK3ywBjXaf-vxrHhuPez3DSZPeSS3_CHQ@mail.gmail.com> (raw)

Severity: minor

The docstring of `progress-reporter-update' contains the following text:

    If REPORTER is a numerical progress reporter---i.e. if it was
     made using non-nil MIN-VALUE and MAX-VALUE arguments to
     `make-progress-reporter'---then VALUE should be a number between
     MIN-VALUE and MAX-VALUE.

If I place point on the space after "i.e." on the first row, and type
C-M-b (backward-sexp), point ends up before "reporter".  (This happens
in `emacs-lisp-mode', but not in `message-mode'; `message-mode' seems to
have no concept of an abbreviation and lands on the "e".)

This in turn leads to checkdoc flagging this as a mistake, and asks you
to put two spaces after dot.

I'm not sure which of these options is true:

A) We should support the above convention of using three dashes in
   `backward-sexp'.  (This is the rough ASCII equivalent of an em dash.)

B) We should just not use the above convention in
   `progress-reporter-update'.





             reply	other threads:[~2021-09-22  6:52 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-22  6:52 Stefan Kangas [this message]
2021-09-22  7:37 ` bug#50731: `progress-reporter-update' docstring and `backward-sexp' interaction Eli Zaretskii
2021-09-22 22:12   ` Stefan Kangas
2021-09-23  6:16     ` Eli Zaretskii
2021-09-23  7:12       ` Stefan Kangas
2021-09-23  7:47         ` Eli Zaretskii
2021-09-23  9:04           ` Stefan Kangas
2021-09-23 20:40             ` Stefan Kangas
2021-09-22 20:35 ` Lars Ingebrigtsen
2021-09-22 22:12   ` Stefan Kangas

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=CADwFkmnpQRGnGAvn8mK3ywBjXaf-vxrHhuPez3DSZPeSS3_CHQ@mail.gmail.com \
    --to=stefan@marxist.se \
    --cc=50731@debbugs.gnu.org \
    /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).