From: Eli Zaretskii <eliz@gnu.org>
To: Eshel Yaron <me@eshelyaron.com>
Cc: 66303@debbugs.gnu.org
Subject: bug#66303: [PATCH] Document 'M-x align' in the Emacs manual
Date: Sat, 14 Oct 2023 11:00:50 +0300 [thread overview]
Message-ID: <83fs2dskel.fsf@gnu.org> (raw)
In-Reply-To: <m1v8bi9ryc.fsf@eshelyaron.com> (message from Eshel Yaron on Sat, 07 Oct 2023 21:02:19 +0200)
> From: Eshel Yaron <me@eshelyaron.com>
> Cc: 66303@debbugs.gnu.org
> Date: Sat, 07 Oct 2023 21:02:19 +0200
>
> New patch:
Thanks. I have a couple of minor issues, and then we can install
this:
> +@findex align
> + You can use the command @kbd{M-x align} to align lines in the
> +current region. This command knows about common alignment patterns
> +across many markup and programming languages. It encodes these
> +patterns as a set of @dfn{alignment rules}, that say how to align
> +different kinds of text in different contexts.
Whenever you use @dfn, you introduce new terminology. New terminology
should always be indexed, so that readers could easily find its
description. So for the above paragraph there should be
@cindex alignment rules.
> +@vindex align-exclude-rules-list
> +@vindex align-mode-exclude-rules-list
> +Besides alignment rules, @kbd{M-x align} uses another kind of rules
> +called @dfn{exclusion rules}. The exclusion rules say which parts in
> +the region @kbd{M-x align} should not align and instead leave them
> +intact. The user option @code{align-exclude-rules-list} specifies
And here we should have
@cindex align exclusion rules
> +@findex align-regexp
> + The command @kbd{M-x align-regexp} lets you align the current region
> +with an alignment rule that you define ad-hoc, instead of using the
> +predefined rules in @code{align-rules-list}. @kbd{M-x align-regexp}
> +prompts you for a regular expression and uses that expression as the
> +@code{regexp} attribute for an ad-hoc alignment rule that this command
> +uses to align the current region. By default, this command adjusts
> +the whitespace that matches the first sub-expression of the regular
> +expression you specify. If you call @kbd{M-x align-regexp} with a
Here and elsewhere you mention regexp sub-expressions. Please add in
those places a cross-reference to where sub-expressions are described
in the manual, since this is an advanced aspect of regexps with which
some readers might not be well acquainted.
next prev parent reply other threads:[~2023-10-14 8:00 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-02 8:21 bug#66303: [PATCH] Document 'M-x align' in the Emacs manual Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-02 16:05 ` Eli Zaretskii
2023-10-02 19:30 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-05 7:52 ` Eli Zaretskii
2023-10-05 10:46 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-07 7:26 ` Eli Zaretskii
2023-10-07 19:02 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-14 8:00 ` Eli Zaretskii [this message]
2023-10-14 10:02 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-14 10:26 ` Eli Zaretskii
2023-10-14 10:47 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-14 11:17 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83fs2dskel.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=66303@debbugs.gnu.org \
--cc=me@eshelyaron.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.