* Should we use `symbol' or 'symbol' in Emacs change logs?
@ 2014-05-29 17:10 Bastien
2014-05-29 18:29 ` Stefan Monnier
0 siblings, 1 reply; 9+ messages in thread
From: Bastien @ 2014-05-29 17:10 UTC (permalink / raw)
To: emacs-devel; +Cc: Achim Gratz
Achim pointed to a recent change about quotes in the GNU coding
standards, and suggests that the change justifies using 'symbol'
instead of `symbol' in Emacs change logs.
http://www.gnu.org/prep/standards/standards.html#index-left-quote
To me, this is about the way GNU programs output the quote char,
not about conventions for symbols used within the program, so my
reading is that Emacs change logs should stick on using `symbol'
rather than 'symbol'.
This seems to be confirmed by the fact that lisp-mode.el still
highlight `symbol' with `font-lock-constant-face'.
Am I reading it wrong or am I correct that there is no change
in Emacs policy regarding the quotation of symbols in change logs
(and in docstrings)?
Thanks,
--
Bastien
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 17:10 Should we use `symbol' or 'symbol' in Emacs change logs? Bastien
@ 2014-05-29 18:29 ` Stefan Monnier
2014-05-29 18:49 ` Bastien
2014-05-29 19:20 ` Achim Gratz
0 siblings, 2 replies; 9+ messages in thread
From: Stefan Monnier @ 2014-05-29 18:29 UTC (permalink / raw)
To: Bastien; +Cc: Achim Gratz, emacs-devel
> Am I reading it wrong or am I correct that there is no change
> in Emacs policy regarding the quotation of symbols in change logs
> (and in docstrings)?
Indeed there's been no change in that policy. To the extent that we
follow the GNU coding standard for the ChangeLogs, you could argue that
we should use 'foo' in ChangeLogs, but the `...' convention is so
pervasive inside Emacs that we'd then either have a mix of conventions
(one for the ChangeLog and another for most everything else) or a major
painful conversion ahead.
Stefan
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 18:29 ` Stefan Monnier
@ 2014-05-29 18:49 ` Bastien
2014-05-29 19:20 ` Achim Gratz
1 sibling, 0 replies; 9+ messages in thread
From: Bastien @ 2014-05-29 18:49 UTC (permalink / raw)
To: Stefan Monnier; +Cc: Achim Gratz, emacs-devel
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> Am I reading it wrong or am I correct that there is no change
>> in Emacs policy regarding the quotation of symbols in change logs
>> (and in docstrings)?
>
> Indeed there's been no change in that policy. To the extent that we
> follow the GNU coding standard for the ChangeLogs, you could argue that
> we should use 'foo' in ChangeLogs, but the `...' convention is so
> pervasive inside Emacs that we'd then either have a mix of conventions
> (one for the ChangeLog and another for most everything else) or a major
> painful conversion ahead.
Okay, thanks for confirming!
--
Bastien
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 18:29 ` Stefan Monnier
2014-05-29 18:49 ` Bastien
@ 2014-05-29 19:20 ` Achim Gratz
2014-05-29 19:52 ` Glenn Morris
1 sibling, 1 reply; 9+ messages in thread
From: Achim Gratz @ 2014-05-29 19:20 UTC (permalink / raw)
To: emacs-devel
Stefan Monnier writes:
>> Am I reading it wrong or am I correct that there is no change
>> in Emacs policy regarding the quotation of symbols in change logs
>> (and in docstrings)?
>
> Indeed there's been no change in that policy. To the extent that we
> follow the GNU coding standard for the ChangeLogs, you could argue that
> we should use 'foo' in ChangeLogs, but the `...' convention is so
> pervasive inside Emacs that we'd then either have a mix of conventions
> (one for the ChangeLog and another for most everything else) or a major
> painful conversion ahead.
Then you might want to document it somewhere and/or do something about:
https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
which suggests otherwise in the examples (including not using quotes
when there is no ambiguity).
Regards,
Achim.
--
+<[Q+ Matrix-12 WAVE#46+305 Neuron microQkb Andromeda XTk Blofeld]>+
SD adaptation for Waldorf rackAttack V1.04R1:
http://Synth.Stromeko.net/Downloads.html#WaldorfSDada
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 19:20 ` Achim Gratz
@ 2014-05-29 19:52 ` Glenn Morris
2014-05-29 20:26 ` Stefan Monnier
2014-05-30 6:43 ` Achim Gratz
0 siblings, 2 replies; 9+ messages in thread
From: Glenn Morris @ 2014-05-29 19:52 UTC (permalink / raw)
To: Achim Gratz; +Cc: emacs-devel
Achim Gratz wrote:
> Then you might want to document it somewhere
Bam, done in trunk r117195.
(Personally I think "every existing ChangeLog in Emacs" was
documentation enough.)
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 19:52 ` Glenn Morris
@ 2014-05-29 20:26 ` Stefan Monnier
2014-05-29 20:33 ` Bastien
2014-05-29 21:48 ` Paul Eggert
2014-05-30 6:43 ` Achim Gratz
1 sibling, 2 replies; 9+ messages in thread
From: Stefan Monnier @ 2014-05-29 20:26 UTC (permalink / raw)
To: Glenn Morris; +Cc: Achim Gratz, emacs-devel
> (Personally I think "every existing ChangeLog in Emacs" was
> documentation enough.)
Agreed. And if someone happens to use 'foo' in a ChangeLog entry, the
world won't fall apart (at least, not immediately).
Stefan
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 20:26 ` Stefan Monnier
@ 2014-05-29 20:33 ` Bastien
2014-05-29 21:48 ` Paul Eggert
1 sibling, 0 replies; 9+ messages in thread
From: Bastien @ 2014-05-29 20:33 UTC (permalink / raw)
To: Stefan Monnier; +Cc: Achim Gratz, emacs-devel
Stefan Monnier <monnier@iro.umontreal.ca> writes:
> Agreed. And if someone happens to use 'foo' in a ChangeLog entry, the
> world won't fall apart (at least, not immediately).
Ah! Cancelling my flight to Mars now.
--
Bastien
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 20:26 ` Stefan Monnier
2014-05-29 20:33 ` Bastien
@ 2014-05-29 21:48 ` Paul Eggert
1 sibling, 0 replies; 9+ messages in thread
From: Paul Eggert @ 2014-05-29 21:48 UTC (permalink / raw)
To: Stefan Monnier, Glenn Morris; +Cc: Achim Gratz, emacs-devel
On 05/29/2014 01:26 PM, Stefan Monnier wrote:
> if someone happens to use 'foo' in a ChangeLog entry, the
> world won't fall apart (at least, not immediately).
'foo' is quite common in Emacs ChangeLogs nowadays. For example, in
src/ChangeLog's most recent ten entries that use single quotes, seven
quote 'like this' and three quote `like this'. We shouldn't insist on
the latter style.
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: Should we use `symbol' or 'symbol' in Emacs change logs?
2014-05-29 19:52 ` Glenn Morris
2014-05-29 20:26 ` Stefan Monnier
@ 2014-05-30 6:43 ` Achim Gratz
1 sibling, 0 replies; 9+ messages in thread
From: Achim Gratz @ 2014-05-30 6:43 UTC (permalink / raw)
To: emacs-devel
Glenn Morris <rgm <at> gnu.org> writes:
> > Then you might want to document it somewhere
>
> Bam, done in trunk r117195.
Thanks.
> (Personally I think "every existing ChangeLog in Emacs" was
> documentation enough.)
If that was indeed so clear cut, I wouldn't have asked.
Regards,
Achim.
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2014-05-30 6:43 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-05-29 17:10 Should we use `symbol' or 'symbol' in Emacs change logs? Bastien
2014-05-29 18:29 ` Stefan Monnier
2014-05-29 18:49 ` Bastien
2014-05-29 19:20 ` Achim Gratz
2014-05-29 19:52 ` Glenn Morris
2014-05-29 20:26 ` Stefan Monnier
2014-05-29 20:33 ` Bastien
2014-05-29 21:48 ` Paul Eggert
2014-05-30 6:43 ` Achim Gratz
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).