[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#37063: 26.2.90; Problems with recent CL support in checkdoc
From: |
Lars Ingebrigtsen |
Subject: |
bug#37063: 26.2.90; Problems with recent CL support in checkdoc |
Date: |
Thu, 10 Oct 2019 02:22:52 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) |
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