Skip to content

Commit 85a46bc

Browse files
committed
docs: clarify return types in docstring (fixes SpotlightKid#112)
Signed-off-by: Christopher Arndt <[email protected]>
1 parent 8231a95 commit 85a46bc

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

rtmidi/midiutil.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def list_output_ports(api=rtmidi.API_UNSPECIFIED):
122122
def open_midiport(port=None, type_="input", api=rtmidi.API_UNSPECIFIED,
123123
use_virtual=False, interactive=True, client_name=None,
124124
port_name=None):
125-
"""Open MIDI port for input or output and return MidiIn/MidiOut instance.
125+
"""Open MIDI port for in-/output and return MidiIn/-Out instance and port name.
126126
127127
Arguments:
128128
@@ -263,10 +263,10 @@ def open_midiport(port=None, type_="input", api=rtmidi.API_UNSPECIFIED,
263263

264264
def open_midiinput(port=None, api=rtmidi.API_UNSPECIFIED, use_virtual=False,
265265
interactive=True, client_name=None, port_name=None):
266-
"""Open a MIDI port for input and return a MidiIn instance.
266+
"""Open a MIDI port for input and return a MidiIn instance and port name.
267267
268-
See the ``open_midiport`` function for information on parameters and
269-
possible exceptions.
268+
See the ``open_midiport`` function for information on parameters, return
269+
types and possible exceptions.
270270
271271
"""
272272
return open_midiport(port, "input", api, use_virtual, interactive,
@@ -275,10 +275,10 @@ def open_midiinput(port=None, api=rtmidi.API_UNSPECIFIED, use_virtual=False,
275275

276276
def open_midioutput(port=None, api=rtmidi.API_UNSPECIFIED, use_virtual=False,
277277
interactive=True, client_name=None, port_name=None):
278-
"""Open a MIDI port for output and return a MidiOut instance.
278+
"""Open a MIDI port for output and return a MidiOut instance and port name.
279279
280-
See the ``open_midiport`` function for information on parameters and
281-
possible exceptions.
280+
See the ``open_midiport`` function for information on parameters, return
281+
types and possible exceptions.
282282
283283
"""
284284
return open_midiport(port, "output", api, use_virtual, interactive,

0 commit comments

Comments
 (0)