W3C home > Mailing lists > Public > spec-prod@w3.org > January to March 2017

Re: Editor's notes

From: fantasai <fantasai.lists@inkedblade.net>
Date: Wed, 22 Feb 2017 23:38:20 -0500
To: spec-prod@w3.org
Message-ID: <78bcaeca-b5ec-b1f2-8af1-d700974c81aa@inkedblade.net>
On 02/22/2017 02:27 PM, Michael Cooper wrote:
> On 2/22/2017 2:12 PM, fantasai wrote:
>> So, here's a question: is there a reason why ednotes should not use .issue styling?
>>
>> (Because, as I mentioned, the CSSWG has been getting along fine with using .issue for this class of usage.)
> I think several people in the thread have said they understand notes, ednotes, and issues to each have distinct semantics from
> each other. While not all groups use all those semantics, some do and we should preserve the feature. So I don't think ednotes
> should have issue styling. I'd just suggest orange to use the familiar traffic light metaphor, of notes being green meaning
> you don't need to worry much, issues being red meaning you should look out, and ednotes being orange or yellow meaning
> something in between. And of course, preserve the distinct "Editorial Note" title when put in by tools. Michael

Orange is already used for advisements.

You also didn't directly answer the question, so let me put some more background and you can try again.

There is clearly a distinction between regular notes (which are intended for users of the spec and are expected to appear in 
its final production) and ednotes (which are intended as an editor's note to himself or his partners). These are not 
currently, but should probably, be distinctly styled.

However, the only distinction brought up between an “issue” and an “ednote“ is that the ednote is not filed in GitHub, and 
originates from the editor himself. If it were filed by someone else (e.g. If *I* read your spec and was like “This seems to 
be missing an introduction” or “This section is confusing and should be rewritten”), it would be in GitHub.

Firstly, I don't think distinguishing the originator of a spec issue is a matter for the spec styles to concern themselves with.

And secondly, if “it's filed in GitHub” vs “it's a concern that's merely inlined into the spec” is a distinction to be made, 
it is already self-evident by the GitHub linking, or lack thereof.

So again, is there a utilitarian reason why ednotes should not use .issue styling?

~fantasai
Received on Thursday, 23 February 2017 04:38:56 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:55:22 UTC