all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Phil Sainty <psainty@orcon.net.nz>
To: npostavs@users.sourceforge.net,
	Robert Cochran <robert-emacs@cochranmail.com>
Cc: "Carlos García" <carloscg@gmail.com>, 24459@debbugs.gnu.org
Subject: bug#24459: 24.5; cl-flet and cl-labels are not properly documented
Date: Thu, 22 Sep 2016 00:11:29 +1200	[thread overview]
Message-ID: <3f1aa880-f9f7-a73e-2cdc-07b4a1a868a9@orcon.net.nz> (raw)
In-Reply-To: <87bmzjz3yw.fsf@users.sourceforge.net>

On 20/09/16 14:42, npostavs@users.sourceforge.net wrote:
> Docstrings indeed shouldn't be too verbose, but it may be worth linking
> to the CL manual which has some more details on these macros.
>
> (cl) Function Bindings,
>
https://www.gnu.org/software/emacs/manual/html_node/cl/Function-Bindings.html

Strongly agreed; but that documentation should also include details
on using cl-letf for dynamic-scope function binding, and the link to
that info node should appear in the docstrings of all three macros.

I also think the summary text at the top of the node should include
something like "The practical difference between the following options
is the scope of the bindings, and therefore which one you use will be
determined by the scope you require."


-Phil





  reply	other threads:[~2016-09-21 12:11 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-18 13:27 bug#24459: 24.5; cl-flet and cl-labels are not properly documented Carlos García
2016-09-20  2:32 ` Robert Cochran
2016-09-20  2:42   ` npostavs
2016-09-21 12:11     ` Phil Sainty [this message]
2019-10-12 20:21     ` Lars Ingebrigtsen

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=3f1aa880-f9f7-a73e-2cdc-07b4a1a868a9@orcon.net.nz \
    --to=psainty@orcon.net.nz \
    --cc=24459@debbugs.gnu.org \
    --cc=carloscg@gmail.com \
    --cc=npostavs@users.sourceforge.net \
    --cc=robert-emacs@cochranmail.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.