From: Noam Postavsky <npostavs@gmail.com>
To: Van L <van@scratch.space>
Cc: 35595@debbugs.gnu.org
Subject: bug#35595: subr.el Commentary + Code sections
Date: Wed, 08 May 2019 07:45:34 -0400 [thread overview]
Message-ID: <87woj1jhk1.fsf@gmail.com> (raw)
In-Reply-To: <4A02DA2E-E698-4F25-BB66-FC7C2365FBDD@scratch.space> (Van L.'s message of "Wed, 8 May 2019 13:40:23 +1000")
Van L <van@scratch.space> writes:
>> On 8 May 2019, at 05:31, npostavs@gmail.com wrote:
>>
>>> ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
>>> ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
>>
>> Not sure if this really qualifies as "introductory comments that explain
>> how the library works." Also, where it says "has tag `utf-8'" what is
>> it referring to? A coding cookie that was since removed perhaps?
>
> To quote from htdp.org/prologue:
Sorry, I was a bit terse above. I was quoting (elisp) Library Headers,
where it says
`;;; Commentary:'
This begins introductory comments that explain how the library
works. It should come right after the copying permissions,
terminated by a `Change Log', `History' or `Code' comment line.
This text is used by the Finder package, so it should make sense
in that context.
[...]
`;;; Code:'
This begins the actual code of the program.
So I'm not sure if the "Beware..." comment belongs under the
"Commentary" header, perhaps it's better put under the "Code:" header,
like the comment about declare-function. And perhaps it makes no sense
to add these headers in the first place, since subr.el isn't exactly a
library.
next prev parent reply other threads:[~2019-05-08 11:45 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-05 23:27 bug#35595: [PATCH] ; update Van L
2019-05-07 19:31 ` bug#35595: subr.el Commentary + Code sections npostavs
2019-05-08 3:40 ` Van L
2019-05-08 11:45 ` Noam Postavsky [this message]
2019-05-08 23:31 ` Van L
2019-06-23 17:05 ` 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=87woj1jhk1.fsf@gmail.com \
--to=npostavs@gmail.com \
--cc=35595@debbugs.gnu.org \
--cc=van@scratch.space \
/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.