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

Add docs for "devicename" parameter in 'pygame.mixer.init()' #2525

Merged
merged 1 commit into from
Oct 26, 2023

Conversation

JiffyRob
Copy link
Contributor

Just noticed that this parameter wasn't documented so I asked around in the discord server to see what it does. You can use pygame._sdl2.audio.get_audio_device_names() to get the valid names for it but since the module is hidden I just mentioned that it changes based on device. Maybe in a future PR we add a public function for it? It seems odd to have a parameter just dangle like this.

@JiffyRob JiffyRob requested a review from a team as a code owner October 22, 2023 19:26
Copy link
Member

@Matiiss Matiiss left a comment

Choose a reason for hiding this comment

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

Looks fine to me otherwise.

docs/reST/ref/mixer.rst Show resolved Hide resolved
@JiffyRob
Copy link
Contributor Author

Usually I'd say "device" but I figured that would be kind of confusing. Writing just system with no specifier also seems very ambiguous. What system?

@yunline yunline added docs mixer pygame.mixer labels Oct 24, 2023
Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Better to have some words about this rather than none. I agree that it is kind of lacking without a documented, non-experimental way to get the list of system audio device names SDL uses - but that is for the future,

Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the PR 🎉

@MyreMylar MyreMylar merged commit f75c45d into pygame-community:main Oct 26, 2023
2 checks passed
@ankith26 ankith26 added this to the 2.4.0 milestone Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs mixer pygame.mixer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants