From 09923a52b2aa33e4e04be872360ea1b5338e233f Mon Sep 17 00:00:00 2001 From: Nanda Scott Date: Sun, 28 Oct 2018 01:09:09 -0400 Subject: [PATCH] Updated all docs to be consistent --- scrython/cards/cardid.py | 2 +- scrython/cards/collector.py | 2 +- scrython/cards/mtgo.py | 2 +- scrython/cards/multiverse.py | 2 +- scrython/cards/named.py | 2 +- scrython/cards/randomcard.py | 2 +- scrython/rulings/arena.py | 8 +++++++- scrython/rulings/mtgo.py | 8 +++++++- scrython/rulings/multiverse_id.py | 8 +++++++- scrython/rulings/scryfall_id.py | 8 +++++++- scrython/rulings/set_code.py | 8 +++++++- scrython/sets/code.py | 8 +++++++- scrython/sets/sets.py | 8 +++++++- scrython/symbology/parse_mana.py | 8 +++++++- scrython/symbology/symbology.py | 11 ++++++++++- 15 files changed, 72 insertions(+), 15 deletions(-) diff --git a/scrython/cards/cardid.py b/scrython/cards/cardid.py index ba4775e..7f272c5 100644 --- a/scrython/cards/cardid.py +++ b/scrython/cards/cardid.py @@ -30,7 +30,7 @@ class Id(CardsObject): Exception: If the 'id' parameter is not provided. Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Id(id="5386a61c-4928-4bd1-babe-5b089ab8b2d9") >>> card.name() """ diff --git a/scrython/cards/collector.py b/scrython/cards/collector.py index 825e4bd..c4a99e1 100644 --- a/scrython/cards/collector.py +++ b/scrython/cards/collector.py @@ -18,7 +18,7 @@ class Collector(CardsObject): Exception: If the 'collector_number' parameter is not provided. Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Collector(code='exo', collector_number='96') >>> card.id() """ diff --git a/scrython/cards/mtgo.py b/scrython/cards/mtgo.py index 7faa3f7..957b845 100644 --- a/scrython/cards/mtgo.py +++ b/scrython/cards/mtgo.py @@ -31,7 +31,7 @@ class Mtgo(CardsObject): Exception: If the 'id' parameter is not provided. Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Mtgo(id="48296") >>> card.set_name() """ diff --git a/scrython/cards/multiverse.py b/scrython/cards/multiverse.py index 595eccb..6263200 100644 --- a/scrython/cards/multiverse.py +++ b/scrython/cards/multiverse.py @@ -30,7 +30,7 @@ class Multiverse(CardsObject): Exception: If the 'id' parameter is not provided. Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Multiverse(id='96865') >>> card.name() """ diff --git a/scrython/cards/named.py b/scrython/cards/named.py index b85e5f7..91afc4c 100644 --- a/scrython/cards/named.py +++ b/scrython/cards/named.py @@ -35,7 +35,7 @@ class Named(CardsObject): Exception: If the 'fuzzy' or 'exact' parameter is not provided. Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Named(exact="Black Lotus") >>> card.colors() """ diff --git a/scrython/cards/randomcard.py b/scrython/cards/randomcard.py index fa9c1d1..05cacd9 100644 --- a/scrython/cards/randomcard.py +++ b/scrython/cards/randomcard.py @@ -29,7 +29,7 @@ class Random(CardsObject): Raises: Exception: If the object returned is an error. - Example usage: + Examples: >>> card = scrython.cards.Random() >>> card.purchase_uris() """ diff --git a/scrython/rulings/arena.py b/scrython/rulings/arena.py index 385b22f..e9f0448 100644 --- a/scrython/rulings/arena.py +++ b/scrython/rulings/arena.py @@ -16,7 +16,13 @@ class Arena(RulingsObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> rule = scrython.rulings.Arena(id='66975') >>> rule.data_length() """ diff --git a/scrython/rulings/mtgo.py b/scrython/rulings/mtgo.py index 8fc9ab5..2a1b47e 100644 --- a/scrython/rulings/mtgo.py +++ b/scrython/rulings/mtgo.py @@ -16,7 +16,13 @@ class Mtgo(RulingsObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> rule = scrython.rulings.Mtgo(id='9611') >>> rule.data_length() """ diff --git a/scrython/rulings/multiverse_id.py b/scrython/rulings/multiverse_id.py index 8270f04..e2c1e92 100644 --- a/scrython/rulings/multiverse_id.py +++ b/scrython/rulings/multiverse_id.py @@ -16,7 +16,13 @@ class Multiverse(RulingsObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> rule = scrython.rulings.Id(id='4301') >>> rule.data_length() """ diff --git a/scrython/rulings/scryfall_id.py b/scrython/rulings/scryfall_id.py index 5c5528d..1ee74ef 100644 --- a/scrython/rulings/scryfall_id.py +++ b/scrython/rulings/scryfall_id.py @@ -16,7 +16,13 @@ class Id(RulingsObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> rule = scrython.rulings.Id(id='5976c352-ac49-4e0d-a4c0-ec9b6b78db9c') >>> rule.data_length() """ diff --git a/scrython/rulings/set_code.py b/scrython/rulings/set_code.py index 2b05b2d..ee168ed 100644 --- a/scrython/rulings/set_code.py +++ b/scrython/rulings/set_code.py @@ -17,7 +17,13 @@ class Code(RulingsObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> rule = scrython.rulings.Code(code='ddg', collector_number='42') >>> rule.data_length() """ diff --git a/scrython/sets/code.py b/scrython/sets/code.py index 4597b6b..0e2f854 100644 --- a/scrython/sets/code.py +++ b/scrython/sets/code.py @@ -15,7 +15,13 @@ class Code(FoundationObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> set = scrython.sets.Code(code='por') >>> set.name() """ diff --git a/scrython/sets/sets.py b/scrython/sets/sets.py index f31fb7e..5e26412 100644 --- a/scrython/sets/sets.py +++ b/scrython/sets/sets.py @@ -13,7 +13,13 @@ class Sets(FoundationObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> set = scrython.sets.Sets() >>> set.data(3, 'name') """ diff --git a/scrython/symbology/parse_mana.py b/scrython/symbology/parse_mana.py index 5d5923a..f54d8c4 100644 --- a/scrython/symbology/parse_mana.py +++ b/scrython/symbology/parse_mana.py @@ -13,7 +13,13 @@ class ParseMana(FoundationObject): pretty (string, optional): Returns a prettier version of the json object. Note that this may break functionality with Scrython. - Example usage: + Returns: + N/A + + Raises: + N/A + + Examples: >>> mana = scrython.symbology.ParseMana(cost="xcug") >>> mana.colors() """ diff --git a/scrython/symbology/symbology.py b/scrython/symbology/symbology.py index 1b6c35a..b0a3c61 100644 --- a/scrython/symbology/symbology.py +++ b/scrython/symbology/symbology.py @@ -6,7 +6,16 @@ class Symbology(FoundationObject): """ /symbology - Example usage: + Args: + N/A + + Returns: + N/A + + Raises: + N/A + + Examples: >>> symbol = scrython.symbology.Symbology() """ def __init__(self):