Skip to content

Fix typos in Sound API documentation #2769 #2772

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.

Sign up for GitHub

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

Merged
pushfoo merged 1 commit into from
Oct 2, 2025
Merged

Fix typos in Sound API documentation #2769 #2772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions arcade/sound.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def play(
.. important:: A :py:class:`Sound` with ``streaming=True`` loses features!

Neither ``loop`` nor simultaneous playbacks will work. See
:py;class:`Sound` and :ref:`sound-loading-modes`.
:py:class:`Sound` and :ref:`sound-loading-modes`.

Args:
volume: Volume (``0.0`` is silent, ``1.0`` is loudest).
Expand Down Expand Up @@ -220,7 +220,7 @@ def load_sound(path: str | Path, streaming: bool = False) -> Sound:
.. important:: A :py:class:`Sound` with ``streaming=True`` loses features!

Neither ``loop`` nor simultaneous playbacks will work. See
:py;class:`Sound` and :ref:`sound-loading-modes`.
:py:class:`Sound` and :ref:`sound-loading-modes`.

Args:
path: a path which may be prefixed with a
Expand All @@ -230,7 +230,7 @@ def load_sound(path: str | Path, streaming: bool = False) -> Sound:
save memory, ``False`` for short sounds to speed playback.

Returns:
A :ref:playable <sound-basics-playing>` instance of a
A :ref:`playable <sound-basics-playing>` instance of a
:py:class:`Sound` object.
"""
# Initialize the audio driver if it hasn't been already.
Expand Down Expand Up @@ -264,7 +264,7 @@ def play_sound(
.. important:: A :py:class:`Sound` with ``streaming=True`` loses features!

Neither ``loop`` nor simultaneous playbacks will work. See
:py;class:`Sound` and :ref:`sound-loading-modes`.
:py:class:`Sound` and :ref:`sound-loading-modes`.

The output and return value depend on whether playback succeeded:
.. # Note: substitutions don't really work inside tables, so the
Expand Down
Loading