Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MIDIOut help file is misleading for Linux #3806

Closed
jamshark70 opened this issue Jun 23, 2018 · 1 comment · Fixed by #3840
Closed

MIDIOut help file is misleading for Linux #3806

jamshark70 opened this issue Jun 23, 2018 · 1 comment · Fixed by #3840
Assignees
Labels
comp: help schelp documentation

Comments

@jamshark70
Copy link
Contributor

While #3805 is pending, we can still fix some rather severe errors in the MIDIOut help file for Linux.

MIDIOut.new(port, uid)
Arguments:
port the index of the MIDIEndPoint in the MIDIClient.destinations array.

Nope. If port is 0, it will look for the SuperCollider:out0 port in the MIDIClient.sources array (yes, sources! ... which makes sense for the ALSA MIDI architecture, but how should a user guess that from reading our help?).

Linux: using the uid is optional as described below.

"Optional" here, but if you leave it out, then it's mandatory to .connect. The "below" discussion is worded in a very confusing way.

There was just an sc-users thread about this. Small wonder the user couldn't get it working on his own.

I don't mind to rewrite it myself, in a day or two (assigning to myself).

@jamshark70 jamshark70 added the comp: help schelp documentation label Jun 23, 2018
@jamshark70 jamshark70 self-assigned this Jun 23, 2018
@mossheim
Copy link
Contributor

Thanks for taking this on! I was following the thread too and was also bewildered

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: help schelp documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants