Updated all other docstrings to let doc_gen work properly

Autocomplete.md

@@ -1,42 +0,0 @@
-# **class** `Autocomplete()`
-These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
-
->In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`{Class_name}().scryfallJson`).
-|cards/autocomplete|
-|Get a list of potential autocompletion phrases.|
-
-## Args
-
-| arg | description |
-|:---:|:---:|
-|q (string):
-|The query of the autocompletion.|
-|format (string, optional):
-|Defaults to 'json'.|
-|Returns data in the specified method.|
-|face (string, optional):
-|Defaults to empty string.|
-|If you're using the `image` format,|
-|this will specify if you want the front or back face.|
-|version (string, optional):
-|Defaults to empty string.|
-|If you're using the `image` format, this will specify|
-|if you want the small, normal, large, etc version of the image.|
-|pretty (string, optional):
-|Defaults to empty string.|
-|Returns a prettier version of the json object.|
-|Note that this may break functionality with Scrython.|
-
-## Raises
-
-| arg | description |
-|:---:|:---:|
-|Exception: If the 'q' parameter is not provided.|
-|Exception: If the object returned is an error.|
-
-## Example usage
-
-| arg | description |
-|:---:|:---:|
-|>>> auto = scrython.cards.Autocomplete(q="Thal")|
-|>>> auto.total_items()|

scrython/bulk_data/bulk_data.py

@@ -10,14 +10,19 @@ class BulkData(FoundationObject):
     """
     /bulk-data
     Queries and creates an object relating to the /bulk-data endpoint.
-    
+
-    Raises:
+    Args:
-        Exception: Raised if Scryfall sends an error object.
+        N/A
-        KeyError: Raised if you attempt to access a key that doesn't exist.
+
-        KeyError: Raise if you attempt to access a tuple key that doesn't exist.
-    
     Returns:
         object: The Scryfall endpoint object.
+
+    Raises:
+        Exception: Raised if Scryfall sends an error object.
+
+    Examples:
+        >>> data = scrython.bulk_data.BulkData()
+        >>> data.bulk_compressed_size()
     """
     def __init__(self, **kwargs):
 

scrython/cards/arena_id.py

@@ -23,11 +23,14 @@ class ArenaId(CardsObject):
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'id' parameter is not provided.
         Exception: If the object returned is an error.
 
-    Example usage:
+    Examples:
         >>> card = scrython.cards.ArenaId(id="66975")
         >>> card.name()
     """

scrython/cards/autocomplete.py

@@ -27,11 +27,14 @@ class Autocomplete(FoundationObject):
             Returns a prettier version of the json object. 
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'q' parameter is not provided.
         Exception: If the object returned is an error.
 
-    Example usage:
+    Examples:
         >>> auto = scrython.cards.Autocomplete(q="Thal")
         >>> auto.total_items()
     """

scrython/cards/cardid.py

@@ -23,6 +23,9 @@ class Id(CardsObject):
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'id' parameter is not provided.
         Exception: If the object returned is an error.

scrython/cards/collector.py

@@ -10,6 +10,9 @@ class Collector(CardsObject):
         collector_number (string): This is the collector number of the card
         lang (string, optional): Defaults to 'en'. A 2-3 character language code.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'code' parameter is not provided.
         Exception: If the 'collector_number' parameter is not provided.

scrython/cards/mtgo.py

@@ -24,6 +24,9 @@ class Mtgo(CardsObject):
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'id' parameter is not provided.
         Exception: If the object returned is an error.

scrython/cards/multiverse.py

@@ -23,6 +23,9 @@ class Multiverse(CardsObject):
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'id' parameter is not provided.
         Exception: If the object returned is an error.

scrython/cards/named.py

@@ -28,6 +28,9 @@ class Named(CardsObject):
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'fuzzy' or 'exact' parameter is not provided.
         Exception: If the object returned is an error.

scrython/cards/randomcard.py

@@ -23,6 +23,9 @@ class Random(CardsObject):
             Returns a prettier version of the json object. 
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the object returned is an error.
 

scrython/cards/search.py

@@ -46,6 +46,9 @@ class Search(FoundationObject):
             Returns a prettier version of the json object. 
             Note that this may break functionality with Scrython.
 
+    Returns:
+        N/A
+
     Raises:
         Exception: If the 'q' parameter is not provided.
         Exception: If the object returned is an error.

scrython/catalog/artifact_types.py

@@ -6,7 +6,16 @@ class ArtifactTypes(CatalogsObject):
 
     Catalog object for all known artifact types
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.ArtifactTypes()
         >>> catalog.data()
     """

scrython/catalog/artist_names.py

@@ -6,7 +6,16 @@ class ArtistNames(CatalogsObject):
 
     Catalog object for all known card names.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.CardNames()
         >>> catalog.data()
     """

scrython/catalog/card_names.py

@@ -6,7 +6,16 @@ class CardNames(CatalogsObject):
 
     Catalog object for all known card names.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.CardNames()
         >>> catalog.data()
     """

scrython/catalog/catalogs_object.py

@@ -14,6 +14,15 @@ class CatalogsObject(FoundationObject):
             Defaults to empty string.
             Returns a prettier version of the json object.
             Note that this may break functionality with Scrython.
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
+        N/A
     """
 
     def object(self):

scrython/catalog/creature_types.py

@@ -6,7 +6,16 @@ class CreatureTypes(CatalogsObject):
 
     Catalog object for all known creature types.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.CreatureTypes()
         >>> catalog.data()
     """

scrython/catalog/enchantment_types.py

@@ -6,7 +6,16 @@ class EnchantmentTypes(CatalogsObject):
 
     Catalog object for all known enchantment types.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.EnchantmentTypes()
         >>> catalog.data()
     """

scrython/catalog/land_types.py

@@ -6,7 +6,16 @@ class LandTypes(CatalogsObject):
 
     Catalog object for all known land types.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.LandTypes()
         >>> catalog.data()
     """

scrython/catalog/loyalties.py

@@ -6,7 +6,16 @@ class Loyalties(CatalogsObject):
 
     Catalog object for all known starting loyalties.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.Loyalties()
         >>> catalog.data()
     """

scrython/catalog/planeswalker_types.py

@@ -6,7 +6,16 @@ class PlaneswalkerTypes(CatalogsObject):
 
     Catalog object for all known planeswalker types.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.PlaneswalkerTypes()
         >>> catalog.data()
     """

scrython/catalog/powers.py

@@ -6,7 +6,16 @@ class Powers(CatalogsObject):
 
     Catalog object for all known powers.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.Powers()
         >>> catalog.data()
     """

scrython/catalog/spell_types.py

@@ -6,7 +6,16 @@ class SpellTypes(CatalogsObject):
 
     Catalog object for all known spell types.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.SpellTypes()
         >>> catalog.data()
     """

scrython/catalog/toughnesses.py

@@ -6,7 +6,16 @@ class Toughnesses(CatalogsObject):
 
     Catalog object for all known toughnesses.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.Toughnesses()
         >>> catalog.data()
     """

scrython/catalog/watermarks.py

@@ -6,7 +6,16 @@ class Watermarks(CatalogsObject):
 
     Catalog object for all known watermarks.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.Watermarks()
         >>> catalog.data()
     """

scrython/catalog/word_bank.py

@@ -6,7 +6,16 @@ class WordBank(CatalogsObject):
 
     Catalog object for all known words on all cards.
 
-    Example usage:
+    Args:
+        N/A
+
+    Returns:
+        N/A
+
+    Raises:
+        N/A
+
+    Examples:
         >>> catalog = scrython.catalog.WordBank()
         >>> catalog.data()
     """