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: Mon, 02 Oct 2023 19:05:24 +0300 [thread overview]
Message-ID: <83wmw56md7.fsf@gnu.org> (raw)
In-Reply-To: <m1fs2tigd5.fsf@eshelyaron.com> (bug-gnu-emacs@gnu.org)
> Date: Mon, 02 Oct 2023 10:21:58 +0200
> From: Eshel Yaron via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>
> This is a request for documenting `M-x align` in the Emacs manual, along
> with a suggested draft for such documentation.
Thanks, but it seems to me we will be better off expanding the doc
string(s) of the respective functions and variables. The text you
suggest to add documents one command and 2 user options, and provides
an example of the usage. I think adding the example to the doc string
of 'align' and mentioning the two options in its doc string, as well
as expanding the doc strings of those two options, would give us the
same benefits without the downsides (extra *.texi file, a larger
manual, etc.)
WDYT?
next prev parent reply other threads:[~2023-10-02 16:05 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 [this message]
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
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
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=83wmw56md7.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 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).