unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Damien Cassou <damien@cassou.me>
Cc: 55569@debbugs.gnu.org
Subject: bug#55569: Improve documentation of mail-user-agent
Date: Sun, 22 May 2022 10:28:38 +0300	[thread overview]
Message-ID: <83sfp26n6h.fsf@gnu.org> (raw)
In-Reply-To: <87czg62fx9.fsf@cassou.me> (message from Damien Cassou on Sun, 22 May 2022 09:18:58 +0200)

> From: Damien Cassou <damien@cassou.me>
> Cc: 55569@debbugs.gnu.org
> Date: Sun, 22 May 2022 09:18:58 +0200
> 
> Hi Eli,
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> >> +@code{mh-e-user-agent}.  Additional options may be available; check
> >> +with the author of your mail user agent package for details.  You may
> >> +also define another mail user agent using `define-mail-user-agent'.
> >
> > Thanks, but what do you mean by "the author of your mail user agent
> > package"?
> 
> 
> I mean that the authors of notmuch and mu4e both define a symbol to be
> used as value for the `mail-user-agent` variable: `mu4e-user-agent` and
> `notmuch-user-agent`.  These symbols should be documented somewhere in
> notmuch and mu4e manuals so their users know they should pass them to
> `mail-user-agent`.  There might be other mail user agent packages out
> there that I don't know about.
> 
> 
> > This is an Emacs user manual, and I very much doubt that
> > Emacs users could figure out where and how to check that.
> >
> > Can we provide more practical advice here how to check for those
> > additional options?
> 
> 
> I could certainly mention the symbols for notmuch and mu4e if you think
> that is ok to mention external packages inside the Emacs manual but I'm
> not sure what else I could do.

If those additional options are supposed to be documented in the MUA
manual, let's suggest that users look in those manuals.  That is IMO
better than to send them to some unnamed "authors".





  reply	other threads:[~2022-05-22  7:28 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-22  6:16 bug#55569: Improve documentation of mail-user-agent Damien Cassou
2022-05-22  6:26 ` Eli Zaretskii
2022-05-22  7:18   ` Damien Cassou
2022-05-22  7:28     ` Eli Zaretskii [this message]
2022-05-22  7:48       ` Damien Cassou
2022-05-22  8:18         ` 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=83sfp26n6h.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=55569@debbugs.gnu.org \
    --cc=damien@cassou.me \
    /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).