From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 66863@debbugs.gnu.org
Subject: bug#66863: [PATCH] Add two docstrings in cl-macs.el
Date: Sat, 04 Nov 2023 09:23:42 +0000 [thread overview]
Message-ID: <87h6m1x450.fsf@jeremybryant.net> (raw)
In-Reply-To: <jwvfs1pishy.fsf-monnier+emacs@gnu.org>
Thank you, I've made a note on conventions. For this patch, as you have
pushed, does this mean this is closed?
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> From 16298965905b1859aa8a342b98803f4abd6da3f0 Mon Sep 17 00:00:00 2001
>> From: Jeremy Bryant <jb@jeremybryant.net>
>> Date: Tue, 31 Oct 2023 23:37:10 +0000
>> Subject: [PATCH] Add two docstrings in cl-macs.el
>
> Thanks, pushed.
>
>> (defun cl--simple-exprs-p (xs)
>> + "Map `cl--simple-expr-p' to each element of list XS."
>
> This doesn't say how the results of `cl--simple-expr-p` are combined,
> it might even suggest they're returned as a list.
> I think I would have said something like
>
> "Like `cl--simple-expr-p' but for a list of expressions."
>
>> (defun cl--const-expr-p (x)
>> + "Check if X is constant (i.e., no side effects or dependencies).
>> +
>> +See `macroexp-const-p' for similar functionality without cl-lib dependency."
>
> "Similar" fails to describe the difference :-(
> [ Note, I can't blame you: I know the difference but I couldn't come up
> with a useful description of it, that is, one that is easier to
> understand than the code itself. FWIW I believe the difference is
> a latent bug, which is partly why I'd like to delete the function :-) ]
>
>
> Stefan
next prev parent reply other threads:[~2023-11-04 9:23 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-31 22:36 bug#66863: [PATCH] Add two docstrings in cl-macs.el Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-31 22:58 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-31 23:40 ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-01 12:17 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-04 9:23 ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-11-04 10:41 ` Stefan Kangas
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=87h6m1x450.fsf@jeremybryant.net \
--to=bug-gnu-emacs@gnu.org \
--cc=66863@debbugs.gnu.org \
--cc=jb@jeremybryant.net \
--cc=monnier@iro.umontreal.ca \
/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.