27317 2014-11-13 17:50:20 +0000 Provide explicit guidance on enum value naming 2015-07-07 06:20:31 +0000 1 1 1 Unclassified WebAppsWG WebIDL unspecified All All RESOLVED FIXED P2 normal --- 1 ddorwin cam annevk bbirtles d hsivonen jackalmage mike mounir public-script-coord steele public-webapps-bugzilla oldest_to_newest 114893 0 ddorwin 2014-11-13 17:50:20 +0000 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 114903 1 bbirtles 2014-11-13 23:49:05 +0000 And in Web Animations we use dashes to match the corresponding CSS keywords: http://w3c.github.io/web-animations/#the-playbackdirection-enumeration 115077 2 ddorwin 2014-11-18 21:53:21 +0000 Can we definitively say whether there is a preference for dashes for new specs? I need to add some multi-word names to a spec, so it would be nice to know what is preferred. Thanks. 116075 3 steele 2014-12-09 22:04:23 +0000 Ping. This is blocking at least one bug in EME we would like to resolve. 116077 4 d 2014-12-09 22:25:19 +0000 I have a slight preference for using dashes (or spaces, but probably too late for that) when we can. Who else should weigh in here? We should get some advice added to the spec if there's agreement. 116078 5 jackalmage 2014-12-09 22:33:39 +0000 Yeah, let's just settle on dashes. More readable, and CSS is definitely going to be using dashes for anything they need. 117211 6 hsivonen 2015-01-15 12:54:37 +0000 I'd like to request that this bikeshed be painted to completion ASAP. I can live with dashes. 117212 7 annevk 2015-01-15 12:59:50 +0000 I think the conclusion is lowercase and either dashes or single word depending on the circumstances (e.g. ArrayBuffer becomes "arraybuffer", not "array-buffer"). I recommend going with that as a general guideline for now. It will likely take some time before IDL is updated. 121842 8 cam 2015-07-07 06:20:31 +0000 https://github.com/heycam/webidl/commit/344ad419defdcd8df313119abe85819e254a8afb