jussi-kalliokoski / webmidi-issues

A test repo for importing the issues from bugzilla
0 stars 0 forks source link

enumerate is misnomer #1

Open jussi-kalliokoski opened 11 years ago

jussi-kalliokoski commented 11 years ago

Originally reported on W3C Bugzilla ISSUE-20500 Mon, 24 Dec 2012 08:10:02 GMT Reported by Marcos Caceres Assigned to This bug has no owner yet - up for the taking

enumerateInputs() and enumerateOutputs() are misnomers (apart from being somewhat hard to type and confusingly named). From reading the spec, my understanding is that methods just "get" a copy of the currently available to the system at the time the method is invoked. The methods don't actually "enumerate" anything in this sense (i.e., give you a number or iterate over a sequence using numbers, etc). Can I kindly request that those two methods be renamed:

getInputs(); getOutputs();

or just: inputs() outputs()

The above are shorter and more closely match the intent of the methods, which is specified as: "Returns a list of the MIDI input ports available on the system." "Returns a list of the MIDI output ports available on the system."

The above definitions should also clarify that these are not a live list (i.e., are not updated as new midi devices are updated or removed from the device).