From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Wed, 22 Sep 2021 22:18:17 +0000 (+0200)
Subject: Clarify align-regexp doc string
X-Git-Tag: emacs-28.0.90~728
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=90547d370f7c75b95b1d1e64b84e624e752ea6e3;p=emacs.git

Clarify align-regexp doc string

* lisp/align.el (align-regexp): Clarify what REGEXP has to
contain, and which bits are added automatically interactively
(bug#33541).
---

diff --git a/lisp/align.el b/lisp/align.el
index 2f380a80774..7ced7b70445 100644
--- a/lisp/align.el
+++ b/lisp/align.el
@@ -897,22 +897,24 @@ align them so that the opening parentheses would line up:
     Mary-Anne (123) 456-7890
     Joe (123) 456-7890
 
-There is no predefined rule to handle this, but you could easily do it
-using a REGEXP like \"(\".  Interactively, all you would have to do is
-to mark the region, call `align-regexp' and enter that regular expression.
-
-REGEXP must contain at least one parenthesized subexpression, typically
-whitespace of the form \"\\\\(\\\\s-*\\\\)\".  In normal interactive use,
-this is automatically added to the start of your regular expression after
-you enter it.  You only need to supply the characters to be lined up, and
-any preceding whitespace is replaced.
-
-If you specify a prefix argument (or use this function non-interactively),
-you must enter the full regular expression, including the subexpression.
-The function also then prompts for which subexpression parenthesis GROUP
-\(default 1) within REGEXP to modify, the amount of SPACING (default
-`align-default-spacing') to use, and whether or not to REPEAT the rule
-throughout the line.
+There is no predefined rule to handle this, but interactively,
+all you would have to do is to mark the region, call `align-regexp'
+and enter \"(\".
+
+REGEXP must contain at least one parenthesized subexpression,
+typically whitespace of the form \"\\\\(\\\\s-*\\\\)\", but in
+interactive use, this is automatically added to the start of your
+regular expression after you enter it.  Interactively, you only
+need to supply the characters to be lined up, and any preceding
+whitespace is replaced.
+
+Non-interactively (or if you specify a prefix argument), you must
+enter the full regular expression, including the subexpression.
+Interactively, the function also then prompts for which
+subexpression parenthesis GROUP (default 1) within REGEXP to
+modify, the amount of SPACING (default `align-default-spacing')
+to use, and whether or not to REPEAT the rule throughout the
+line.
 
 See `align-rules-list' for more information about these options.