unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Mattias Engdegård" <mattias.engdegard@gmail.com>
To: Stefan Kangas <stefankangas@gmail.com>
Cc: 66636@debbugs.gnu.org
Subject: bug#66636: Move lexical-binding warning from checkdoc to byte-compiler
Date: Fri, 20 Oct 2023 12:15:18 +0200	[thread overview]
Message-ID: <C88ED85D-2FA3-465D-9347-6505E8459C2C@gmail.com> (raw)
In-Reply-To: <CADwFkmmJkXNECKEhWL-7ALhK9sxAhEc459G1nRRgPzJLBe54QQ@mail.gmail.com>

19 okt. 2023 kl. 19.40 skrev Stefan Kangas <stefankangas@gmail.com>:

>> +    ;;; My little pony mode  -*- lexical-binding: t -*-
> 
> If we want this to conform with the format required by package.el, this
> should be:
> 
> ;;; pony.el --- My little pony mode  -*- lexical-binding: t -*-
> 
> Or would that distract from the main point?

Indeed the example was chosen to avoid anything irrelevant. If anything should go it would be the pony, but I put it there to remind the user that it's fine to include something else that obviously isn't parsed.
Something too formal-looking might give the impression of compulsory and/or machine-readable structure.

(I always found this traditional first line to be somewhat of an uneasy composite: too often it forces unnatural brevity on the description, or becomes so long that it wraps. I'd favour dedicating the first line to the -*- cookie alone.)

> On a side note, it would be good to also highlight this in the relevant
> sections of the manual.

Yes, the manual needs updating in some respects. I'll do this separately to keep the text as coherent as possible.

Thank you for the kind review!






  reply	other threads:[~2023-10-20 10:15 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-19 11:48 bug#66636: Move lexical-binding warning from checkdoc to byte-compiler Mattias Engdegård
2023-10-19 11:55 ` Eli Zaretskii
2023-10-19 14:12   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-19 17:40 ` Stefan Kangas
2023-10-20 10:15   ` Mattias Engdegård [this message]
2023-10-20 20:55     ` Stefan Kangas
2023-10-20  6:09 ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-20  7:01   ` Eli Zaretskii
2023-10-20  7:13     ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-20  7:21       ` Eli Zaretskii
2023-10-20 19:44         ` Stefan Kangas
2023-10-20 13:38   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-20 17:40     ` Mattias Engdegård
2023-10-20 19:27       ` Eli Zaretskii
2023-10-21  9:53         ` Mattias Engdegård
2023-10-21 11:17           ` Eli Zaretskii
2023-10-21 13:17             ` Mattias Engdegård
2023-10-21 14:42             ` Drew Adams
2023-10-21 15:44             ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-21 16:08               ` Eli Zaretskii
2023-10-22  0:15               ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-22  4:12                 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-22  5:16                   ` Eli Zaretskii
2023-10-22  5:28                     ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-10-20 16:27   ` Drew Adams

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=C88ED85D-2FA3-465D-9347-6505E8459C2C@gmail.com \
    --to=mattias.engdegard@gmail.com \
    --cc=66636@debbugs.gnu.org \
    --cc=stefankangas@gmail.com \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).