Skip to content

Commit 3ae49b4

Browse files
committed
Fix code example directives
Apparently `Example:` (single colon) works for doctests but `Example::` (2 colons) is required for non-doctest examples.
1 parent 4ccd7e1 commit 3ae49b4

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

tcod/sdl/audio.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
It leaves the loading to sound samples to other libraries like
99
`SoundFile <https://pysoundfile.readthedocs.io/en/latest/>`_.
1010
11-
Example:
11+
Example::
12+
1213
# Synchronous audio example
1314
import time
1415
@@ -211,7 +212,8 @@ def convert_audio(
211212
class AudioDevice:
212213
"""An SDL audio device.
213214
214-
Example:
215+
Example::
216+
215217
device = tcod.sdl.audio.get_default_playback().open() # Open a common audio device
216218
217219
.. versionchanged:: 16.0
@@ -957,7 +959,8 @@ def get_capture_devices() -> dict[str, AudioDevice]:
957959
def get_default_playback() -> AudioDevice:
958960
"""Return the default playback device.
959961
960-
Example:
962+
Example::
963+
961964
playback_device = tcod.sdl.audio.get_default_playback().open()
962965
963966
.. versionadded:: 19.0
@@ -969,7 +972,8 @@ def get_default_playback() -> AudioDevice:
969972
def get_default_recording() -> AudioDevice:
970973
"""Return the default recording device.
971974
972-
Example:
975+
Example::
976+
973977
recording_device = tcod.sdl.audio.get_default_recording().open()
974978
975979
.. versionadded:: 19.0

0 commit comments

Comments
 (0)