diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2021-09-23 00:18:17 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-09-23 00:18:21 +0200 |
commit | 90547d370f7c75b95b1d1e64b84e624e752ea6e3 (patch) | |
tree | 42b94be8e1a123d495b0eb1773bd8a443e8710c9 /lisp | |
parent | bf0c072913c2c3c4e3ef4936762215b8f83a9498 (diff) | |
download | emacs-90547d370f7c75b95b1d1e64b84e624e752ea6e3.tar.gz emacs-90547d370f7c75b95b1d1e64b84e624e752ea6e3.tar.bz2 emacs-90547d370f7c75b95b1d1e64b84e624e752ea6e3.zip |
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).
Diffstat (limited to 'lisp')
-rw-r--r-- | lisp/align.el | 34 |
1 files changed, 18 insertions, 16 deletions
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. |