From 22c1cca4ea0ed8a0028857fa5ae24e546f6c9d54 Mon Sep 17 00:00:00 2001 From: NandaScott Date: Mon, 6 Sep 2021 12:34:14 -0400 Subject: [PATCH] Updated docs --- docs/scrython.cards/ArenaId.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Collector.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Id.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Mtgo.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Multiverse.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Named.md | 31 ++++++++++++++++++++++++++++--- docs/scrython.cards/Random.md | 31 ++++++++++++++++++++++++++++--- 7 files changed, 196 insertions(+), 21 deletions(-) diff --git a/docs/scrython.cards/ArenaId.md b/docs/scrython.cards/ArenaId.md index 507036e..e4abd79 100644 --- a/docs/scrython.cards/ArenaId.md +++ b/docs/scrython.cards/ArenaId.md @@ -151,6 +151,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -166,8 +177,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -387,6 +400,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -463,7 +478,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -665,6 +680,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Collector.md b/docs/scrython.cards/Collector.md index ef7ef7c..1df4b27 100644 --- a/docs/scrython.cards/Collector.md +++ b/docs/scrython.cards/Collector.md @@ -148,6 +148,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -163,8 +174,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -384,6 +397,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -460,7 +475,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -662,6 +677,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Id.md b/docs/scrython.cards/Id.md index ca1991e..ef12b6e 100644 --- a/docs/scrython.cards/Id.md +++ b/docs/scrython.cards/Id.md @@ -151,6 +151,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -166,8 +177,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -387,6 +400,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -463,7 +478,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -665,6 +680,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Mtgo.md b/docs/scrython.cards/Mtgo.md index 64b03f0..a591937 100644 --- a/docs/scrython.cards/Mtgo.md +++ b/docs/scrython.cards/Mtgo.md @@ -151,6 +151,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -166,8 +177,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -387,6 +400,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -463,7 +478,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -665,6 +680,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Multiverse.md b/docs/scrython.cards/Multiverse.md index 3e0f747..fdf03e4 100644 --- a/docs/scrython.cards/Multiverse.md +++ b/docs/scrython.cards/Multiverse.md @@ -151,6 +151,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -166,8 +177,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -387,6 +400,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -463,7 +478,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -665,6 +680,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Named.md b/docs/scrython.cards/Named.md index 5c9d123..8b0b78d 100644 --- a/docs/scrython.cards/Named.md +++ b/docs/scrython.cards/Named.md @@ -153,6 +153,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -168,8 +179,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -389,6 +402,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -465,7 +480,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -667,6 +682,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()` diff --git a/docs/scrython.cards/Random.md b/docs/scrython.cards/Random.md index 8f8808d..5512530 100644 --- a/docs/scrython.cards/Random.md +++ b/docs/scrython.cards/Random.md @@ -149,6 +149,17 @@ The rank of the card on edhrec.com Returns: int: The rank of the card on edhrec.co +``` +--- +### `finishes()` + +``` +A list of computer-readable flags that indicate if this card + can come in foil, nonfoil, etched, or glossy finishes. + + Returns: + list: A list of all finishes. + ``` --- ### `flavor_text()` @@ -164,8 +175,10 @@ The flavor text of the card, if any ### `foil()` ``` -True if this printing exists in a foil version - +True if this printing exists in a foil version. + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. + Returns: boolean @@ -385,6 +398,8 @@ The oracle name of the card ``` True if this printing does not exist in foil + + DEPRECATION NOTICE: This method will be deprecated on Nov 1, 2021. Returns: boolean @@ -461,7 +476,7 @@ Preview information for this card, if any. ### `prices()` ``` -Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix` +Returns prices from modes `usd`, `usd_foil`, `usd_etched`, `usd_glossy`, `eur`, and `tix` Args: mode (string): The prices to get @@ -663,6 +678,16 @@ True if this card is featured in the story Returns: boolean +``` +--- +### `tcgplayer_etched_id()` + +``` +The `etched_id` of the card on TCGplayer. + + Returns: + integer: The TCGplayer etched id of the card + ``` --- ### `tcgplayer_id()`