From: Lars Ingebrigtsen <larsi@gnus.org>
To: "Mattias Engdegård" <mattiase@acm.org>
Cc: 55905@debbugs.gnu.org
Subject: bug#55905: warn about misplaced or duplicated doc strings, `declare` or `interactive` forms
Date: Sat, 11 Jun 2022 14:44:59 +0200 [thread overview]
Message-ID: <87leu3qshg.fsf@gnus.org> (raw)
In-Reply-To: <7541DAE8-38BD-4CF6-A652-744E31C42442@acm.org> ("Mattias Engdegård"'s message of "Sat, 11 Jun 2022 14:07:03 +0200")
Mattias Engdegård <mattiase@acm.org> writes:
> In function definitions, doc strings, `declare` and `interactive`
> forms are each optional but must appear in that order and duplications
> are not permitted. Many violations against these rules go undetected.
>
> The attached patch adds checks to `defun` and `defmacro`. Violations
> result in compilation warnings but it could be changed into hard
> errors if desired. It also accepts `(:documentation EXPR)` as
> alternative to a doc string literal, which currently doesn't work i
> all cases.
This is most welcome -- I can never remember myself what the order of
declare and interactive is.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2022-06-11 12:44 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-11 12:07 bug#55905: warn about misplaced or duplicated doc strings, `declare` or `interactive` forms Mattias Engdegård
2022-06-11 12:44 ` Lars Ingebrigtsen [this message]
2022-06-17 15:30 ` Mattias Engdegård
2022-06-12 12:14 ` dick
2022-06-12 12:45 ` Mattias Engdegård
2022-06-12 13:05 ` dick
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=87leu3qshg.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=55905@debbugs.gnu.org \
--cc=mattiase@acm.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.