From: Lars Ingebrigtsen <larsi@gnus.org>
To: Damien Cassou <damien@cassou.me>
Cc: Alex Branham <alex.branham@gmail.com>, 37063@debbugs.gnu.org
Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc
Date: Thu, 10 Oct 2019 02:22:52 +0200 [thread overview]
Message-ID: <87mue9sb37.fsf@gnus.org> (raw)
In-Reply-To: <87imqw10je.fsf@cassou.me> (Damien Cassou's message of "Sat, 17 Aug 2019 13:41:57 +0200")
Damien Cassou <damien@cassou.me> writes:
> In the context of bug#37034, some initial support for CL functions and
> methods was added to checkdoc. On my code, the changes make checkdoc
> trigger warnings on perfectly valid code IMO. For example,
>
> (cl-defmethod foo ((a list)) "Return A.")
>
> Checkdoc complains that LIST should be described. I disagree with that,
> list is a type, not a argument name.
>
> I attach to this bug report a patch introducing test cases to
> checkdoc-tests.el. If it's not possible to implement full support for CL
> I prefer that checkdoc doesn't complain even if there is a bug in the
> docstring rather than checkdoc complains when the docstring is correct.
After a patch was submitted that fixed most of the cases (except the
&context and &aux ones, I believe), I've applied your checkdoc-tests.el
patch (except those two functions).
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2019-10-10 0:22 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-17 11:41 bug#37063: 26.2.90; Problems with recent CL support in checkdoc Damien Cassou
2019-09-30 16:52 ` dick.r.chiang
2019-10-10 0:21 ` Lars Ingebrigtsen
2019-10-10 0:22 ` Lars Ingebrigtsen [this message]
2019-10-10 4:15 ` Damien Cassou
2019-10-10 16:45 ` Glenn Morris
2019-10-11 5:48 ` 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=87mue9sb37.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=37063@debbugs.gnu.org \
--cc=alex.branham@gmail.com \
--cc=damien@cassou.me \
/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.