emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Phil Hudson <phil.hudson@iname.com>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs orgmode-mailinglist <emacs-orgmode@gnu.org>
Subject: Re: org-agenda-filter-by-tag doco
Date: Sun, 8 May 2022 14:50:07 +0100	[thread overview]
Message-ID: <CAJ1MqVEpWtvTTQvS2Po3MpdE_S7CD+ihdG=B5P+th3SX=95q-w@mail.gmail.com> (raw)
In-Reply-To: <87k0awqii7.fsf@localhost>

Fair enough. I follow your reasoning and it seems sound. Please close.

On Sun, 8 May 2022 at 14:07, Ihor Radchenko <yantar92@gmail.com> wrote:
>
> Phil Hudson <phil.hudson@iname.com> writes:
>
> > 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 do not think that it is a good idea. There is not much point
> explaining basic Emacs concepts discussed in Emacs/Elisp manual in every
> docstring of functions making use of universal arguments.
>
> Note that C-u gets automatically highlighted when you view the function
> docstring. Clicking on it brings you to the docstring for universal
> argument, which, in turn, also contains a link to the manual page.
>
> I think it is good enough.
>
> Best,
> Ihor


      reply	other threads:[~2022-05-08 13:51 UTC|newest]

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

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='CAJ1MqVEpWtvTTQvS2Po3MpdE_S7CD+ihdG=B5P+th3SX=95q-w@mail.gmail.com' \
    --to=phil.hudson@iname.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@gmail.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/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).