Fix some docstrings

Metron-Project · Feb 8, 2024 · 3e81400 · 3e81400
1 parent d22791b
commit 3e81400
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 9 deletions.
diff --git a/mokkari/__init__.py b/mokkari/__init__.py
@@ -18,8 +18,8 @@ def api(
     Args:
         username (str): The username used for metron.cloud.
         passwd (str): The password used for metron.cloud.
-        SqliteCache optional: SqliteCache to use
-        user_agent optional(str): The user agent string for the application using Mokkari.
+        cache (SqliteCache): SqliteCache to use
+        user_agent (str): The user agent string for the application using Mokkari.
         For example 'Foo Bar/1.0'.
 
     Returns:

diff --git a/mokkari/schemas/arc.py b/mokkari/schemas/arc.py
@@ -13,7 +13,7 @@
 
 class Arc(BaseResource):
     """
-    The Arc object extends :obj:`BaseArc` providing  all information for a story arc.
+    The Arc object extends :obj:`BaseResource` providing  all information for a story arc.
 
     Attributes:
         desc (str): The description of the story arc.

diff --git a/mokkari/schemas/character.py b/mokkari/schemas/character.py
@@ -14,7 +14,7 @@
 
 class Character(BaseResource):
     """
-    The Character object extends :obj:`BaseCharacter` providing  all information for a character.
+    The Character object extends :obj:`BaseResource` providing  all information for a character.
 
     Attributes:
         alias (list[str]): The alias of the character.

diff --git a/mokkari/schemas/creator.py b/mokkari/schemas/creator.py
@@ -15,7 +15,7 @@
 
 class Creator(BaseResource):
     """
-    The Creator object extends :obj:`BaseCreator` providing  all information for a creator.
+    The Creator object extends :obj:`BaseResource` providing  all information for a creator.
 
     Attributes:
         birth (date): The date of birth for the creator.

diff --git a/mokkari/schemas/issue.py b/mokkari/schemas/issue.py
@@ -56,7 +56,7 @@ class BasicSeries(BaseModel):
 
 class IssueSeries(BaseModel):
     """
-    The :obj:`AssociatedSeries` object contains more detailed series information.
+    The :obj:`IssueSeries` object contains more detailed series information.
 
     Attributes:
         id (int): The Metron identification number for series.

diff --git a/mokkari/schemas/publisher.py b/mokkari/schemas/publisher.py
@@ -13,7 +13,7 @@
 
 class Publisher(BaseResource):
     """
-    The Publisher object extends :obj:`BasePublisher` providing  all information for a publisher.
+    The Publisher object extends :obj:`BaseResource` providing  all information for a publisher.
 
     Attributes:
         founded (int): The year the publisher was founded.

diff --git a/mokkari/schemas/team.py b/mokkari/schemas/team.py
@@ -14,7 +14,7 @@
 
 class Team(BaseResource):
     """
-    The Team object extends the :obj:`BaseTeam` by containing all information for a team.
+    The Team object extends the :obj:`BaseResource` by containing all information for a team.
 
     Attributes:
         desc (str): The description of the team.

diff --git a/mokkari/schemas/universe.py b/mokkari/schemas/universe.py
@@ -14,7 +14,7 @@
 
 class Universe(BaseResource):
     """
-    The Universe object extends the :obj:`BaseUniverse` by containing information for a universe.
+    The Universe object extends the :obj:`BaseResource` by containing information for a universe.
 
     Attributes:
         publisher (int): The Metron identification number for the publisher