W3C home > Mailing lists > Public > public-script-coord@w3.org > October to December 2014

[Bug 27317] New: Provide explicit guidance on enum value naming

From: <bugzilla@jessica.w3.org>
Date: Thu, 13 Nov 2014 17:50:20 +0000
To: public-script-coord@w3.org
Message-ID: <bug-27317-3890@http.www.w3.org/Bugs/Public/>
https://www.w3.org/Bugs/Public/show_bug.cgi?id=27317

            Bug ID: 27317
           Summary: Provide explicit guidance on enum value naming
           Product: WebAppsWG
           Version: unspecified
          Hardware: All
                OS: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: WebIDL
          Assignee: cam@mcc.id.au
          Reporter: ddorwin@google.com
        QA Contact: public-webapps-bugzilla@w3.org
                CC: mike@w3.org, public-script-coord@w3.org

It is not clear from http://heycam.github.io/webidl/#idl-enums how spec authors
should name enum values, especially those that are composed of more than one
word. The examples are all single words. "enumeration-values" might imply that
dashes should be used to separate the words, but there seems to be uncertainty
on this [1][2].

Please provide explicit guidance, including case and whether/how to separate
words.

Existing and active specs are inconsistent but seem to tend toward use of
dashes:
- Fetch is using a mix of concatenation and dashes:
   https://fetch.spec.whatwg.org/#requestcontext
- Screen Orientation is using dashes:
   https://w3c.github.io/screen-orientation/#orientationtype-enum
- Web Audio has one of each:
   http://webaudio.github.io/web-audio-api/
- WebRTC uses dashes:
   http://www.w3.org/TR/webrtc/

[1]
http://lists.w3.org/Archives/Public/public-script-coord/2013OctDec/0184.html
[2]
http://lists.w3.org/Archives/Public/public-script-coord/2014OctDec/0147.html

-- 
You are receiving this mail because:
You are on the CC list for the bug.
Received on Thursday, 13 November 2014 17:50:26 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 17:14:23 UTC