Skip to content

Commit ca6bbc8

Browse files
authored
Merge pull request #2738 from lispspb/patch-2
Update mixer docs
2 parents dd11ffc + 01ab95f commit ca6bbc8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/reST/ref/mixer.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ The following file formats are supported
443443
| :sl:`get the playback volume`
444444
| :sg:`get_volume() -> value`
445445
446-
Return a value from 0.0 to 1.0 representing the volume for this Sound.
446+
Return a value from 0.0 to 1.0 (inclusive) representing the volume for this Sound.
447447

448448
.. ## Sound.get_volume ##
449449
@@ -484,7 +484,7 @@ The following file formats are supported
484484
| :sg:`Channel(id) -> Channel`
485485
486486
Return a Channel object for one of the current channels. The id must be a
487-
value from 0 to the value of ``pygame.mixer.get_num_channels()``.
487+
value from 0 up to, but not including, ``pygame.mixer.get_num_channels()``.
488488

489489
The Channel object can be used to get fine control over the playback of
490490
Sounds. A channel can only playback a single Sound at time. Using channels
@@ -589,7 +589,7 @@ The following file formats are supported
589589
590590
Set the volume (loudness) of a playing sound. When a channel starts to
591591
play its volume value is reset. This only affects the current sound. The
592-
value argument is between 0.0 and 1.0.
592+
value argument is in the range of 0.0 to 1.0 (inclusive).
593593

594594
If one argument is passed, it will be the volume of both speakers. If two
595595
arguments are passed and the mixer is in stereo mode, the first argument
@@ -615,7 +615,8 @@ The following file formats are supported
615615
| :sl:`get the volume of the playing channel`
616616
| :sg:`get_volume() -> value`
617617
618-
Return the volume of the channel for the current playing sound. This does
618+
Return the volume of the channel for the current playing sound
619+
in the range of 0.0 to 1.0 (inclusive). This does
619620
not take into account stereo separation used by
620621
:meth:`Channel.set_volume`. The Sound object also has its own volume
621622
which is mixed with the channel.

0 commit comments

Comments
 (0)