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

Document Windows limitation on usb_midi.set_names(audio_control_interface_name=...) #9946

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dhalbert
Copy link
Collaborator

Fixes #9871.

usb_midi.set_names() prevents the MIDI device from being recognized if audio_control_interface_name is 32 chars or more. We can't check for this because we can't find out the host OS, but it's now documented.

I also prevented the doc build from looking inside things in ports/analog it shouldn't bother to look in.

Comment on lines +200 to +201
"ports/analog/msdk",
"ports/analog/peripherals",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this frequently vexes me. perhaps we should explicitly list the documents we want with include_patterns instead (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-include_patterns)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that idea.

Copy link
Member

@jepler jepler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

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

Successfully merging this pull request may close these issues.

Long audio_control_interface_name appears to be incompatible with Windows
2 participants