bug#39290: [PATCH] Correct regexp for flags in 'format' doc string

bug#39290: [PATCH] Correct regexp for flags in 'format' doc string

[Mattias Engdegård]

[-- Attachment #1: Type: text/plain, Size: 403 bytes --]

The doc string for 'format' contains

  where field is [0-9]+ followed by a literal dollar "$", flags is
  [+ #-0]+, width is [0-9]+, and precision is a literal period "."
  followed by [0-9]+.

The spec for flags isn't a correct regexp; the hyphen should be last.  This matters, because people copy it into their code without thinking (observed in the wild).

Patch acceptable for emacs-27?


[-- Attachment #2: 0001-Correct-regexp-for-flags-in-format-doc-string.patch --]
[-- Type: application/octet-stream, Size: 1010 bytes --]

From 5245a818d978a96c17c3ec7b99d93e32a07f90e6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Engdeg=C3=A5rd?= <mattiase@acm.org>
Date: Sun, 26 Jan 2020 15:07:45 +0100
Subject: [PATCH] Correct regexp for flags in `format' doc string

* src/editfns.c (Fformat): Use the correct regexp for describing the
flags in a %-sequence (place the hyphen last).
---
 src/editfns.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/editfns.c b/src/editfns.c
index 4e35784e55..3f1b3aa4b7 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -3031,7 +3031,7 @@ DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
   %<field><flags><width><precision>character
 
 where field is [0-9]+ followed by a literal dollar "$", flags is
-[+ #-0]+, width is [0-9]+, and precision is a literal period "."
+[+ #0-]+, width is [0-9]+, and precision is a literal period "."
 followed by [0-9]+.
 
 If a %-sequence is numbered with a field with positive value N, the
-- 
2.21.0 (Apple Git-122.2)

bug#39290: [PATCH] Correct regexp for flags in 'format' doc string

[Paul Eggert]

Thanks, I installed that in your name into the emacs-27 branch. I think doc 
fixes like that are still good for the emacs-27 branch.

bug#39290: [PATCH] Correct regexp for flags in 'format' doc string

[Eli Zaretskii]

> From: Paul Eggert <eggert@cs.ucla.edu>
> Date: Sun, 26 Jan 2020 10:08:17 -0800
> Cc: 39290-done@debbugs.gnu.org
> 
> Thanks, I installed that in your name into the emacs-27 branch. I think doc 
> fixes like that are still good for the emacs-27 branch.

Doc fixes are always good for the release branch.  It's in CONTRIBUTE.

bug#39290: [PATCH] Correct regexp for flags in 'format' doc string

[Mattias Engdegård]

26 jan. 2020 kl. 20.19 skrev Eli Zaretskii <eliz@gnu.org>:
> 
>> Thanks, I installed that in your name into the emacs-27 branch. I think doc 
>> fixes like that are still good for the emacs-27 branch.
> 
> Doc fixes are always good for the release branch.  It's in CONTRIBUTE.

Thank you both!