added to docs, still deciding on style

29th-Day · Dec 29, 2023 · 0d14bba · 0d14bba
1 parent e093368
commit 0d14bba
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 13 deletions.
diff --git a/.vscode/retropy.code-workspace b/.vscode/retropy.code-workspace
@@ -11,7 +11,8 @@
 		"cSpell.words": [
 			"frontends",
 			"libretro",
-			"retropy"
+			"retropy",
+			"Savestate"
 		]
 	}
 }
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,5 +1,8 @@
 # Installation
 
+Supported python versions: ...
+Supported OS: ...
+
 ## pip
 
 ```
@@ -27,4 +30,4 @@ The current development version can be download via
 git clone https://github.com/29th-Day/retropy.git
 ```
 
-[^1]: `ModuleNotFoundError` will be raised if unavailable feature is called
+[^1]: `FeatureNotAvailable` will be raised if unavailable feature is called
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
@@ -1,8 +1,8 @@
 # Tutorials
 
-This section is intendet to get the user going with retropy.
+This section is intended to get the user going with retropy.
 
-Throughout this section, the two variables are assumned to be present and valid.
+Throughout this section, the two variables are assumed to be present and valid.
 
 ``` py
 dll_path = "path/to/core.*" # path to libretro core

diff --git a/src/retropy/core/retro.py b/src/retropy/core/retro.py
@@ -40,7 +40,13 @@
 
 
 class RetroPy:
-    """Python(ic) frontend for libretro"""
+    """
+    Python(ic) frontend for libretro
+
+    Attributes:
+        pixel_format (PixelFormat): Pixel format
+        memory (RAM): memory
+    """
 
     pixel_format: PixelFormat
     core_variables: dict[bytes, dict[str, bytes | Sequence[bytes]]] = {}
@@ -208,10 +214,6 @@ def __init__(self, path: str, numpy: bool = True) -> None:
             EnvironmentCommand.GET_DEVICE_POWER: self.env_GET_DEVICE_POWER,
             EnvironmentCommand.SET_NETPACKET_INTERFACE: self.env_SET_NETPACKET_INTERFACE,
         }
-        """Handles all libretro environment commands.
-        
-        Can be overwritten or expanded to modify behaviour.
-        """
 
         # Create callback objects (and keep them in scope)
         self.__cb_env = cb.environment_t(self.environment)

diff --git a/src/retropy/utils/exceptions.py b/src/retropy/utils/exceptions.py
@@ -23,8 +23,8 @@ class GameCannotBeLoaded(RuntimeError):
     pass
 
 
-class UnkownEnvironmentCommand(RuntimeError):
-    """Envrionment command used by core is not recognized."""
+class UnknownEnvironmentCommand(RuntimeError):
+    """Environment command used by core is not recognized."""
 
     pass
 
@@ -39,3 +39,9 @@ class SavestateError(RuntimeError):
     """Savestate could not be handled."""
 
     pass
+
+
+class FeatureNotAvailable(ModuleNotFoundError):
+    """A requested feature is not currently available."""
+
+    pass
diff --git a/tests/test.py b/tests/test.py
@@ -44,8 +44,6 @@ def pygame():
     core.cheats["9 Lives"] = b"AATOZE"
     core.cheats.pop("9 Lives")
 
-    # core.cheats["9 Lives"].enabled = False
-
     core.run()