all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 22336@debbugs.gnu.org, dgutov@yandex.ru
Subject: bug#22336: 25.0.50; cl-generic.el features are not documented in ELisp manual
Date: Sun, 24 Jan 2016 18:00:58 -0500	[thread overview]
Message-ID: <jwvfuxm1t7m.fsf-monnier+emacsbugs@gnu.org> (raw)
In-Reply-To: <83h9i33v3a.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 24 Jan 2016 16:34:01 +0200")

> ':method' is in the doc string, which for me was a clear sign it
> should be documented.

I consider that the docstring should be a "reference" documenting as
much of the supported behavior as possible, whereas the manual should be
more accessible (give context and examples) and less exhaustive.

> Such dynamically-updated doc string would be very good to have, I
> think, but I needed to work with what was there, and of course
> couldn't use the kind of intimate knowledge of the implementation that
> you have.

I definitely understand that, and I thank you for doing this work.


        Stefan





      reply	other threads:[~2016-01-24 23:00 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-09  9:06 bug#22336: 25.0.50; cl-generic.el features are not documented in ELisp manual Eli Zaretskii
2016-01-09 10:07 ` Eli Zaretskii
2016-01-16  8:25 ` Eli Zaretskii
2016-01-22 21:17   ` Eli Zaretskii
2016-01-23  5:29     ` Dmitry Gutov
2016-01-23  6:06       ` Eli Zaretskii
2016-01-23  8:20         ` Dmitry Gutov
2016-01-23 12:51           ` Eli Zaretskii
2016-01-23 17:02             ` Dmitry Gutov
2016-01-23 17:21               ` Eli Zaretskii
2016-01-24  0:45                 ` Dmitry Gutov
2016-01-24  0:48                   ` Dmitry Gutov
2016-01-24  5:03               ` Stefan Monnier
2016-01-24 14:34                 ` Eli Zaretskii
2016-01-24 23:00                   ` Stefan Monnier [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

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

  git send-email \
    --in-reply-to=jwvfuxm1t7m.fsf-monnier+emacsbugs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=22336@debbugs.gnu.org \
    --cc=dgutov@yandex.ru \
    --cc=eliz@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 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.