Minor fixs (#42)

* Fix spelling errors
* Fix docstrings

esak/character.py

@@ -50,7 +50,7 @@ class Character:
     """
 
     def __init__(self, **kwargs):
-        """Intialize a new Character."""
+        """Initialize a new Character."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/comic.py

@@ -91,7 +91,7 @@ class Comic:
     """
 
     def __init__(self, **kwargs):
-        """Intialize a new comic."""
+        """Initialize a new comic."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/creator.py

@@ -54,7 +54,7 @@ class Creator:
     """
 
     def __init__(self, **kwargs):
-        """Intialize a new Creator."""
+        """Initialize a new Creator."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/dates.py

@@ -36,7 +36,7 @@ class Dates:
     """
 
     def __init__(self, on_sale=None, foc=None, unlimited=None, **kwargs):
-        """Intialize a new date."""
+        """Initialize a new date."""
         self.on_sale = on_sale
         self.foc = foc
         self.unlimited = unlimited

esak/event.py

@@ -58,7 +58,7 @@ class Events:
     """
 
     def __init__(self, **kwargs) -> None:
-        """Intialize a new event."""
+        """Initialize a new event."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/prices.py

@@ -32,7 +32,7 @@ class Prices:
     """
 
     def __init__(self, print=None, digital=None, **kwargs):
-        """Intialize a new price."""
+        """Initialize a new price."""
         self.print = print
         self.digital = digital
         self.unknown = kwargs

esak/series.py

@@ -59,7 +59,7 @@ class Series:
     """
 
     def __init__(self, **kwargs):
-        """Intialize a new series."""
+        """Initialize a new series."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/session.py

@@ -37,8 +37,8 @@ class Session:
         The public_key for authentication with Marvel
     private_key: str
         The private_key used for authentication with Marvel
-    SqliteCache: optional, SqliteCache
-        SqliteCache to use
+    sqlite_cache.SqliteCache: optional, sqlite_cache.SqliteCache
+        sqlite_cache.SqliteCache to use
 
     Returns
     -------
@@ -52,7 +52,7 @@ def __init__(
         private_key: str,
         cache: sqlite_cache.SqliteCache | None = None,
     ):
-        """Intialize a new Session."""
+        """Initialize a new Session."""
         self.header = {
             "User-Agent": f"esak/{__version__} ({platform.system()}; {platform.release()})"
         }
@@ -61,12 +61,13 @@ def __init__(
         self.cache = cache
         self.api_url = "http://gateway.marvel.com:80/v1/public/{}"
 
-    def _create_cached_params(self, params: dict[str, Any]) -> str:
+    @staticmethod
+    def _create_cached_params(params: dict[str, Any]) -> str:
         # Generate part of cache key before hash, apikey and timestamp added
         cache_params = ""
         if params:
-            orderedParams = OrderedDict(sorted(params.items(), key=lambda t: t[0]))
-            cache_params = f"?{urllib.parse.urlencode(orderedParams)}"
+            ordered_params = OrderedDict(sorted(params.items(), key=lambda t: t[0]))
+            cache_params = f"?{urllib.parse.urlencode(ordered_params)}"
         return cache_params
 
     def _create_auth_hash(self, now_string: str) -> str:
@@ -539,8 +540,6 @@ def creators_list(self, params: dict[str, Any] | None = None) -> cr.CreatorsList
 
         Parameters
         ----------
-        _id: int
-            The creator id.
         params: dict, optional
             Parameters to add to the request.
 
@@ -676,8 +675,6 @@ def characters_list(self, params: dict[str, Any] | None = None) -> ch.Characters
 
         Parameters
         ----------
-        _id: int
-            The character id.
         params: dict, optional
             Parameters to add to the request.
 

esak/sqlite_cache.py

@@ -30,7 +30,7 @@ class SqliteCache:
     """
 
     def __init__(self, db_name: str = "esak_cache.db", expire: int | None = None) -> None:
-        """Intialize a new SqliteCache."""
+        """Initialize a new SqliteCache."""
         self.expire = expire
         self.con = sqlite3.connect(db_name)
         self.cur = self.con.cursor()

esak/stories.py

@@ -54,7 +54,7 @@ class Stories:
     """
 
     def __init__(self, **kwargs) -> None:
-        """Intialize a new story."""
+        """Initialize a new story."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/summary.py

@@ -34,7 +34,7 @@ class Summary:
     """
 
     def __init__(self, id=None, name=None, resource_uri=None, type=None, role=None, **kwargs):
-        """Intialize a new Summary."""
+        """Initialize a new Summary."""
         self.id = id
         self.name = name
         self.resource_uri = resource_uri

esak/text_object.py

@@ -30,7 +30,7 @@ class TextObject:
     """
 
     def __init__(self, **kwargs):
-        """Intialize a new TextObjects."""
+        """Initialize a new TextObjects."""
         for k, v in kwargs.items():
             setattr(self, k, v)
 

esak/urls.py

@@ -57,7 +57,7 @@ def __init__(
         detail=None,
         **kwargs,
     ):
-        """Intialize a new url."""
+        """Initialize a new url."""
         self.digital_purchase_date = digital_purchase_date
         self.foc_date = foc_date
         self.onsale_date = onsale_date