Fixed many typos in the tcod.sdl package.

HexDecimal · HexDecimal · commit 37ec7c0ef139 · 2023-05-27T18:49:46.000-07:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -57,6 +57,8 @@
         "bfade",
         "bgcolor",
         "bitmask",
+        "bitorder",
+        "BITSIZE",
         "BKGND",
         "Blit",
         "blits",
@@ -123,6 +125,7 @@
         "DISPLAYSWITCH",
         "dlopen",
         "Doryen",
+        "DPAD",
         "DTEEE",
         "DTEEN",
         "DTEES",
@@ -149,6 +152,8 @@
         "frombuffer",
         "fullscreen",
         "fwidth",
+        "GAMECONTROLLER",
+        "gamepad",
         "genindex",
         "GFORCE",
         "GLES",
@@ -220,12 +225,18 @@
         "LDFLAGS",
         "LEFTBRACE",
         "LEFTBRACKET",
+        "LEFTDOWN",
         "LEFTPAREN",
+        "LEFTSHOULDER",
+        "LEFTSTICK",
+        "LEFTUP",
+        "LEFTX",
         "lerp",
         "LGUI",
         "libsdl",
         "libtcod",
         "libtcodpy",
+        "linspace",
         "liskin",
         "LMASK",
         "lmeta",
@@ -289,8 +300,10 @@
         "onefile",
         "OPENGL",
         "OPER",
+        "packbits",
         "PAGEDOWN",
         "PAGEUP",
+        "PATCHLEVEL",
         "pathfinding",
         "pathlib",
         "pcpp",
@@ -329,7 +342,12 @@
         "RGUI",
         "RIGHTBRACE",
         "RIGHTBRACKET",
+        "RIGHTDOWN",
         "RIGHTPAREN",
+        "RIGHTSHOULDER",
+        "RIGHTSTICK",
+        "RIGHTUP",
+        "RIGHTX",
         "RMASK",
         "rmeta",
         "roguelike",
@@ -354,18 +372,21 @@
         "servernum",
         "setuptools",
         "SHADOWCAST",
+        "SIZEALL",
         "SIZENESW",
         "SIZENS",
         "SIZENWSE",
         "SIZEWE",
         "SMILIE",
         "snprintf",
+        "soundfile",
         "stdeb",
         "struct",
         "structs",
         "SUBP",
         "SYSREQ",
         "tablefmt",
+        "TARGETTEXTURE",
         "tcod",
         "tcoddoc",
         "TCODK",
@@ -383,6 +404,9 @@
         "toctree",
         "todos",
         "tolist",
+        "touchpad",
+        "TRIGGERLEFT",
+        "TRIGGERRIGHT",
         "tris",
         "truetype",
         "typestr",
@@ -405,6 +429,8 @@
         "voronoi",
         "VRAM",
         "vsync",
+        "VULKAN",
+        "WAITARROW",
         "WASD",
         "waterlevel",
         "windowclose",
diff --git a/tcod/sdl/audio.py b/tcod/sdl/audio.py
@@ -1,11 +1,11 @@
 """SDL2 audio playback and recording tools.
 
-This module includes SDL's low-level audio API and a naive implentation of an SDL mixer.
+This module includes SDL's low-level audio API and a naive implementation of an SDL mixer.
 If you have experience with audio mixing then you might be better off writing your own mixer or
 modifying the existing one which was written using Python/Numpy.
 
 This module is designed to integrate with the wider Python ecosystem.
-It leaves the loading to sound samples to other libaries like
+It leaves the loading to sound samples to other libraries like
 `SoundFile <https://pysoundfile.readthedocs.io/en/latest/>`_.
 
 Example::
@@ -17,9 +17,9 @@
     import tcod.sdl.audio
 
     device = tcod.sdl.audio.open()  # Open the default output device.
-    sound, samplerate = soundfile.read("example_sound.wav", dtype="float32")  # Load an audio sample using SoundFile.
-    converted = device.convert(sound, samplerate)  # Convert this sample to the format expected by the device.
-    device.queue_audio(converted)  # Play audio syncroniously by appending it to the device buffer.
+    sound, sample_rate = soundfile.read("example_sound.wav", dtype="float32")  # Load an audio sample using SoundFile.
+    converted = device.convert(sound, sample_rate)  # Convert this sample to the format expected by the device.
+    device.queue_audio(converted)  # Play audio synchronously by appending it to the device buffer.
 
     while device.queued_samples:  # Wait until device is done playing.
         time.sleep(0.001)
@@ -33,8 +33,8 @@
     import tcod.sdl.audio
 
     mixer = tcod.sdl.audio.BasicMixer(tcod.sdl.audio.open())  # Setup BasicMixer with the default audio output.
-    sound, samplerate = soundfile.read("example_sound.wav")  # Load an audio sample using SoundFile.
-    sound = mixer.device.convert(sound, samplerate)  # Convert this sample to the format expected by the device.
+    sound, sample_rate = soundfile.read("example_sound.wav")  # Load an audio sample using SoundFile.
+    sound = mixer.device.convert(sound, sample_rate)  # Convert this sample to the format expected by the device.
     channel = mixer.play(sound)  # Start asynchronous playback, audio is mixed on a separate Python thread.
     while channel.busy:  # Wait until the sample is done playing.
         time.sleep(0.001)
@@ -59,7 +59,7 @@
 
 
 def _get_format(format: DTypeLike) -> int:
-    """Return a SDL_AudioFormat bitfield from a NumPy dtype."""
+    """Return a SDL_AudioFormat bit-field from a NumPy dtype."""
     dt: Any = np.dtype(format)
     assert dt.fields is None
     bitsize = dt.itemsize * 8
@@ -83,15 +83,15 @@ def _dtype_from_format(format: int) -> np.dtype[Any]:
     """Return a dtype from a SDL_AudioFormat."""
     bitsize = format & lib.SDL_AUDIO_MASK_BITSIZE
     assert bitsize % 8 == 0
-    bytesize = bitsize // 8
+    byte_size = bitsize // 8
     byteorder = ">" if format & lib.SDL_AUDIO_MASK_ENDIAN else "<"
     if format & lib.SDL_AUDIO_MASK_DATATYPE:
         kind = "f"
     elif format & lib.SDL_AUDIO_MASK_SIGNED:
         kind = "i"
     else:
         kind = "u"
-    return np.dtype(f"{byteorder}{kind}{bytesize}")
+    return np.dtype(f"{byteorder}{kind}{byte_size}")
 
 
 def convert_audio(
@@ -103,8 +103,8 @@ def convert_audio(
 
     Args:
         in_sound: The input ArrayLike sound sample.  Input format and channels are derived from the array.
-        in_rate: The samplerate of the input array.
-        out_rate: The samplerate of the output array.
+        in_rate: The sample-rate of the input array.
+        out_rate: The sample-rate of the output array.
         out_format: The output format of the converted array.
         out_channels: The number of audio channels of the output array.
 
@@ -142,7 +142,7 @@ class AudioDevice:
 
     Open new audio devices using :any:`tcod.sdl.audio.open`.
 
-    When you use this object directly the audio passed to :any:`queue_audio` is always played syncroniously.
+    When you use this object directly the audio passed to :any:`queue_audio` is always played synchronously.
     For more typical asynchronous audio you should pass an AudioDevice to :any:`BasicMixer`.
     """
 
@@ -231,7 +231,7 @@ def convert(self, sound: ArrayLike, rate: int | None = None) -> NDArray[Any]:
 
         Args:
             sound: An ArrayLike sound sample.
-            rate: The samplerate of the input array.
+            rate: The sample-rate of the input array.
                   If None is given then it's assumed to be the same as the device.
 
         .. versionadded:: 13.6
diff --git a/tcod/sdl/mouse.py b/tcod/sdl/mouse.py
@@ -148,7 +148,7 @@ def get_cursor() -> Cursor | None:
 def capture(enable: bool) -> None:
     """Enable or disable mouse capture to track the mouse outside of a window.
 
-    It is highly reccomended to read the related remarks section in the SDL docs before using this.
+    It is highly recommended to read the related remarks section in the SDL docs before using this.
 
     Example::
 
diff --git a/tcod/sdl/sys.py b/tcod/sdl/sys.py
@@ -60,8 +60,8 @@ def _get_power_info() -> tuple[_PowerState, int, int]:
     buffer = ffi.new("int[2]")
     power_state = _PowerState(lib.SDL_GetPowerInfo(buffer, buffer + 1))
     seconds_of_power = buffer[0]
-    percenage = buffer[1]
-    return power_state, seconds_of_power, percenage
+    percentage = buffer[1]
+    return power_state, seconds_of_power, percentage
 
 
 def _get_clipboard() -> str:
diff --git a/tcod/sdl/video.py b/tcod/sdl/video.py
@@ -262,7 +262,7 @@ def border_size(self) -> tuple[int, int, int, int]:
 
     @property
     def opacity(self) -> float:
-        """Get or set this windows opacity.  0.0 is fully transarpent and 1.0 is fully opaque.
+        """Get or set this windows opacity.  0.0 is fully transparent and 1.0 is fully opaque.
 
         Will error if you try to set this and opacity isn't supported.
         """
