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

Update mixer docs #2738

Merged
merged 2 commits into from
May 26, 2024
Merged

Update mixer docs #2738

merged 2 commits into from
May 26, 2024

Conversation

lispspb
Copy link
Contributor

@lispspb lispspb commented Mar 4, 2024

I think mixer module docs need some clarification.
A value from 0 to the value of get_num_channels() is for [0-num_channels), while the value argument is between 0.0 and 1.0, volume in the range of 0.0 to 1.0 (inclusive) and a value from 0.0 to 1.0 representing the volume mean [0.0-1.0].
Should it be "from x to y (inclusive/exclusive)" everywhere?

Clarify mixer docs
@lispspb lispspb requested a review from a team as a code owner March 4, 2024 15:27
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.

Thanks for the PR!

I have left a minor review suggestion at one place, the rest of the changes LGTM

docs/reST/ref/mixer.rst Outdated Show resolved Hide resolved
@yunline yunline added docs mixer pygame.mixer labels Mar 20, 2024
@Starbuck5
Copy link
Member

I disagree that the "0.0 -1.0" range needs clarification for volume.

docs/reST/ref/mixer.rst Outdated Show resolved Hide resolved
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. Sure, it makes the wording slightly more verbose, but it reduces the room for any confusion I guess. Therefore I think this PR is a merge-able state now.

Thanks for contributing to pygame-ce! 🎉

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.

OK 👍

@MyreMylar MyreMylar merged commit ca6bbc8 into pygame-community:main May 26, 2024
3 checks passed
@MyreMylar MyreMylar added this to the 2.5.0 milestone May 26, 2024
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