emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Phil Hudson <phil.hudson@iname.com>
To: emacs orgmode-mailinglist <emacs-orgmode@gnu.org>
Subject: org-agenda-filter-by-tag doco
Date: Sun, 28 Nov 2021 10:27:02 +0000	[thread overview]
Message-ID: <CAJ1MqVGvWrTywr7J8+CcdGdhF72R8QDbtZ+OXLZ-h=PJkntvTg@mail.gmail.com> (raw)

I'd like to expand the docstring of command `org-agenda-filter-by-tag`
to document the Elisp equivalent of interactive prefix arguments. By
trial and error and guesswork I determined that I could emulate `C-u
C-u` by passing `'(16)` as the second argument
(`strip-or-accumulate`). I'd like to add text explaining this,
generalized to all prefix combinations.

I just thought I'd mention it on the list first, to get any thoughts
and advice that might be useful. For instance, currently there is a
paragraph for each prefix combination (`C-u`, `C-u C-u` and `C-u C-u
C-u`). Should I add Elisp calling doco to each, or should I expand the
subsequent paragraph that deals specifically with Elisp calling? I
tend to favor the latter as least confusing, but that might be a
matter of convention or opinion that others are better qualified to
comment on.

A further point: I already knew from prolonged usage that `C-u`
combinations evaluate numerically as powers of 4, but a newbie might
not. Should we explain this? I don't think it would be appropriate,
but again I'm open to advice. If not, should we at least link to the
explanation in the Elisp manual? I know we don't usually bother, but
since outcomes differ substantively in this case, maybe we should
here.


             reply	other threads:[~2021-11-28 10:27 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-28 10:27 Phil Hudson [this message]
2022-05-08 13:08 ` org-agenda-filter-by-tag doco Ihor Radchenko
2022-05-08 13:50   ` Phil Hudson

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.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAJ1MqVGvWrTywr7J8+CcdGdhF72R8QDbtZ+OXLZ-h=PJkntvTg@mail.gmail.com' \
    --to=phil.hudson@iname.com \
    --cc=emacs-orgmode@gnu.org \
    /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/org-mode.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).