From ce29649a73bf8d735399f14c44ce30c9389347d2 Mon Sep 17 00:00:00 2001 From: NandaScott Date: Mon, 1 Apr 2019 13:01:17 -0400 Subject: [PATCH] Updated docs --- docs/scrython.cards/ArenaId.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Collector.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Id.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Mtgo.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Multiverse.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Named.md | 88 +++++++++++++++++++------------ docs/scrython.cards/Random.md | 88 +++++++++++++++++++------------ 7 files changed, 378 insertions(+), 238 deletions(-) diff --git a/docs/scrython.cards/ArenaId.md b/docs/scrython.cards/ArenaId.md index 7853370..2110c96 100644 --- a/docs/scrython.cards/ArenaId.md +++ b/docs/scrython.cards/ArenaId.md @@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -207,6 +181,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -219,13 +203,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -448,6 +432,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -518,6 +528,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -621,13 +641,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Collector.md b/docs/scrython.cards/Collector.md index 2145216..73dc745 100644 --- a/docs/scrython.cards/Collector.md +++ b/docs/scrython.cards/Collector.md @@ -128,32 +128,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -204,6 +178,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -216,13 +200,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -445,6 +429,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -485,6 +485,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -515,6 +525,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -618,13 +638,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Id.md b/docs/scrython.cards/Id.md index 3ed1b92..4ab0bf3 100644 --- a/docs/scrython.cards/Id.md +++ b/docs/scrython.cards/Id.md @@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -207,6 +181,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -219,13 +203,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -448,6 +432,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -518,6 +528,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -621,13 +641,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Mtgo.md b/docs/scrython.cards/Mtgo.md index 66fac54..7dddef8 100644 --- a/docs/scrython.cards/Mtgo.md +++ b/docs/scrython.cards/Mtgo.md @@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -207,6 +181,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -219,13 +203,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -448,6 +432,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -518,6 +528,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -621,13 +641,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Multiverse.md b/docs/scrython.cards/Multiverse.md index 3166b53..58fdbb5 100644 --- a/docs/scrython.cards/Multiverse.md +++ b/docs/scrython.cards/Multiverse.md @@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -207,6 +181,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -219,13 +203,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -448,6 +432,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -518,6 +528,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -621,13 +641,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Named.md b/docs/scrython.cards/Named.md index fcc270d..0324bbf 100644 --- a/docs/scrython.cards/Named.md +++ b/docs/scrython.cards/Named.md @@ -133,32 +133,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -209,6 +183,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -221,13 +205,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -450,6 +434,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -490,6 +490,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -520,6 +530,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -623,13 +643,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` --- diff --git a/docs/scrython.cards/Random.md b/docs/scrython.cards/Random.md index c165a01..d7b3ec4 100644 --- a/docs/scrython.cards/Random.md +++ b/docs/scrython.cards/Random.md @@ -129,32 +129,6 @@ A list of strings with all colors found in the mana cost Returns: list -``` ---- -### `colorshifted()` - -``` -Returns True if the card is colorshifted - - Returns: - boolean - -``` ---- -### `currency()` - -``` -Returns currency from modes `usd`, `eur`, and `tix` - - Args: - mode (string): The currency to get - - Raises: - KeyError: If the mode parameter does not match a known key - - Returns: - float: The currency as a float - ``` --- ### `digital()` @@ -205,6 +179,16 @@ The year of the card frame Returns: string +``` +--- +### `frame_effect()` + +``` +The card's frame effect, if any. (miracle, nyxtouched, etc.) + + Returns: + string: The card's frame effect. + ``` --- ### `full_art()` @@ -217,13 +201,13 @@ Returns True if the card is considered full art ``` --- -### `futureshifted()` +### `games()` ``` -Returns True if the card is futureshifted - +A list of games that this card print is available in. + Returns: - boolean + array: A list of games ``` --- @@ -446,6 +430,22 @@ The power of the creature, if applicable Returns: string +``` +--- +### `prices()` + +``` +Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` + + Args: + mode (string): The prices to get + + Raises: + KeyError: If the mode parameter does not match a known key + + Returns: + float: The prices as a float + ``` --- ### `printed_name()` @@ -486,6 +486,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall Returns: string +``` +--- +### `promo()` + +``` +True if this card is a promotional print. + + Returns: + boolean + ``` --- ### `purchase_uris()` @@ -516,6 +526,16 @@ A dictionary of related websites for this card Returns: dict +``` +--- +### `released_at()` + +``` +The date this card was first released. + + Returns: + string: The date in ISO format + ``` --- ### `reprint()` @@ -619,13 +639,13 @@ True if this card is featured in the story ``` --- -### `timeshifted()` +### `tcgplayer_id()` ``` -Returns True if the card is timeshifted - +The `productId` of the card on TCGplayer. + Returns: - boolean + integer: The TCGplayer id of the card ``` ---