Updated all docs to be consistent
This commit is contained in:
parent
d100070938
commit
09923a52b2
|
@ -30,7 +30,7 @@ class Id(CardsObject):
|
||||||
Exception: If the 'id' parameter is not provided.
|
Exception: If the 'id' parameter is not provided.
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Id(id="5386a61c-4928-4bd1-babe-5b089ab8b2d9")
|
>>> card = scrython.cards.Id(id="5386a61c-4928-4bd1-babe-5b089ab8b2d9")
|
||||||
>>> card.name()
|
>>> card.name()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -18,7 +18,7 @@ class Collector(CardsObject):
|
||||||
Exception: If the 'collector_number' parameter is not provided.
|
Exception: If the 'collector_number' parameter is not provided.
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Collector(code='exo', collector_number='96')
|
>>> card = scrython.cards.Collector(code='exo', collector_number='96')
|
||||||
>>> card.id()
|
>>> card.id()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -31,7 +31,7 @@ class Mtgo(CardsObject):
|
||||||
Exception: If the 'id' parameter is not provided.
|
Exception: If the 'id' parameter is not provided.
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Mtgo(id="48296")
|
>>> card = scrython.cards.Mtgo(id="48296")
|
||||||
>>> card.set_name()
|
>>> card.set_name()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -30,7 +30,7 @@ class Multiverse(CardsObject):
|
||||||
Exception: If the 'id' parameter is not provided.
|
Exception: If the 'id' parameter is not provided.
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Multiverse(id='96865')
|
>>> card = scrython.cards.Multiverse(id='96865')
|
||||||
>>> card.name()
|
>>> card.name()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -35,7 +35,7 @@ class Named(CardsObject):
|
||||||
Exception: If the 'fuzzy' or 'exact' parameter is not provided.
|
Exception: If the 'fuzzy' or 'exact' parameter is not provided.
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Named(exact="Black Lotus")
|
>>> card = scrython.cards.Named(exact="Black Lotus")
|
||||||
>>> card.colors()
|
>>> card.colors()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -29,7 +29,7 @@ class Random(CardsObject):
|
||||||
Raises:
|
Raises:
|
||||||
Exception: If the object returned is an error.
|
Exception: If the object returned is an error.
|
||||||
|
|
||||||
Example usage:
|
Examples:
|
||||||
>>> card = scrython.cards.Random()
|
>>> card = scrython.cards.Random()
|
||||||
>>> card.purchase_uris()
|
>>> card.purchase_uris()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -16,7 +16,13 @@ class Arena(RulingsObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.rulings.Arena(id='66975')
|
||||||
>>> rule.data_length()
|
>>> rule.data_length()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -16,7 +16,13 @@ class Mtgo(RulingsObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.rulings.Mtgo(id='9611')
|
||||||
>>> rule.data_length()
|
>>> rule.data_length()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -16,7 +16,13 @@ class Multiverse(RulingsObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.rulings.Id(id='4301')
|
||||||
>>> rule.data_length()
|
>>> rule.data_length()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -16,7 +16,13 @@ class Id(RulingsObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.rulings.Id(id='5976c352-ac49-4e0d-a4c0-ec9b6b78db9c')
|
||||||
>>> rule.data_length()
|
>>> rule.data_length()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -17,7 +17,13 @@ class Code(RulingsObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.rulings.Code(code='ddg', collector_number='42')
|
||||||
>>> rule.data_length()
|
>>> rule.data_length()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -15,7 +15,13 @@ class Code(FoundationObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.sets.Code(code='por')
|
||||||
>>> set.name()
|
>>> set.name()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -13,7 +13,13 @@ class Sets(FoundationObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.sets.Sets()
|
||||||
>>> set.data(3, 'name')
|
>>> set.data(3, 'name')
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -13,7 +13,13 @@ class ParseMana(FoundationObject):
|
||||||
pretty (string, optional):
|
pretty (string, optional):
|
||||||
Returns a prettier version of the json object. Note that this may break functionality with Scrython.
|
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 = scrython.symbology.ParseMana(cost="xcug")
|
||||||
>>> mana.colors()
|
>>> mana.colors()
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -6,7 +6,16 @@ class Symbology(FoundationObject):
|
||||||
"""
|
"""
|
||||||
/symbology
|
/symbology
|
||||||
|
|
||||||
Example usage:
|
Args:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Examples:
|
||||||
>>> symbol = scrython.symbology.Symbology()
|
>>> symbol = scrython.symbology.Symbology()
|
||||||
"""
|
"""
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
|
|
Loading…
Reference in New Issue