Skip to content

Commit 63284db

Browse files
authored
Merge pull request #3272 from Starbuck5/docs-updates
Docs updates (mainly to mixer)
2 parents 4b413fe + 5d4be79 commit 63284db

File tree

3 files changed

+8
-12
lines changed

3 files changed

+8
-12
lines changed

docs/reST/ref/image.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ following formats.
245245

246246
.. note:: The use of this function is recommended over :func:`tostring` as of pygame 2.1.3.
247247
This function was introduced so it matches nicely with other
248-
libraries (PIL, numpy, etc), and with people's expectations.
248+
libraries (PIL, NumPy, etc), and with people's expectations.
249249

250250
.. versionadded:: 2.1.3
251251
.. versionchanged:: 2.2.0 Now supports keyword arguments.
@@ -290,7 +290,7 @@ following formats.
290290

291291
.. note:: The use of this function is recommended over :func:`fromstring` as of pygame 2.1.3.
292292
This function was introduced so it matches nicely with other
293-
libraries (PIL, numpy, etc), and with people's expectations.
293+
libraries (PIL, NumPy, etc), and with people's expectations.
294294

295295
.. versionadded:: 2.1.3
296296
.. versionadded:: 2.1.4 Added a 'pitch' argument and support for keyword arguments.

docs/reST/ref/mixer.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
| :sl:`pygame module for loading and playing sounds`
1010
1111
This module contains classes for loading Sound objects and controlling
12-
playback. The mixer module is optional and depends on SDL_mixer. Your program
13-
should test that :mod:`pygame.mixer` is available and initialized before using
14-
it.
12+
playback.
1513

1614
The mixer module has a limited number of channels for playback of sounds.
1715
Usually programs tell pygame to start playing audio and it selects an available
@@ -30,9 +28,7 @@ streams the music from the files without loading music at once into memory.
3028

3129
The mixer module must be initialized like other pygame modules, but it has some
3230
extra conditions. The ``pygame.mixer.init()`` function takes several optional
33-
arguments to control the playback rate and sample size. Pygame will default to
34-
reasonable values, but pygame cannot perform Sound resampling, so the mixer
35-
should be initialized to match the values of your audio resources.
31+
arguments to control the playback rate and sample size.
3632

3733
``NOTE``: For less laggy sound use a smaller buffer size. The default
3834
is set to reduce the chance of scratchy sounds on some computers. You can
@@ -91,7 +87,7 @@ The following file formats are supported
9187
the next nearest power of 2).
9288

9389
The devicename parameter is the name of sound device to open for audio
94-
playback. Allowed device names will vary based on the host system.
90+
playback. Allowed device names will vary based on the host system.
9591
If left as ``None`` then a sensible default will be chosen for you.
9692

9793
Some platforms require the :mod:`pygame.mixer` module to be initialized
@@ -331,7 +327,7 @@ The following file formats are supported
331327
:rtype: tuple
332328

333329
.. note::
334-
The linked and compile version numbers should be the same.
330+
The linked and compiled version numbers should be the same.
335331

336332
.. versionaddedold:: 2.0.0
337333

@@ -368,7 +364,7 @@ The following file formats are supported
368364
it and the Sound object.
369365

370366
For now buffer and array support is consistent with ``sndarray.make_sound``
371-
for Numeric arrays, in that sample sign and byte order are ignored. This
367+
for NumPy arrays, in that sample sign and byte order are ignored. This
372368
will change, either by correctly handling sign and byte order, or by raising
373369
an exception when different. Also, source samples are truncated to fit the
374370
audio sample size. This will not change.

docs/reST/ref/surfarray.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ specific pixel value of a color. Integer pixel values can only be used directly
3030
between surfaces with matching pixel layouts (see :class:`pygame.Surface`).
3131

3232
All functions that refer to "array" will copy the surface information to a new
33-
numpy array. All functions that refer to "pixels" will directly reference the
33+
NumPy array. All functions that refer to "pixels" will directly reference the
3434
pixels from the surface and any changes performed to the array will make changes
3535
in the surface. As this last functions share memory with the surface, this one
3636
will be locked during the lifetime of the array.

0 commit comments

Comments
 (0)