From cc99128914805314806d64f82a2d8fd311e809da Mon Sep 17 00:00:00 2001 From: Nanda Scott Date: Mon, 19 Feb 2018 17:09:21 -0500 Subject: [PATCH] Updated docs. --- docs/Cards.md | 12 ------------ docs/Catalog.md | 24 ++++++++++++------------ docs/Rulings.md | 2 +- docs/Sets.md | 2 +- docs/Symbology.md | 2 +- 5 files changed, 15 insertions(+), 27 deletions(-) diff --git a/docs/Cards.md b/docs/Cards.md index 1a4ca6d..7078caa 100644 --- a/docs/Cards.md +++ b/docs/Cards.md @@ -74,16 +74,12 @@ Gets a card by the name. >Since the `/cards/named` endpoint specifically requires the fuzzy or exact markers, they are required to be explicitly denoted. ---- - ## *class* `cards.Random()` Get a random card. **Parameters:** No parameters are required. ---- - ## *class* `cards.Multiverse()` Get a card by Multiverse id @@ -93,8 +89,6 @@ Get a card by Multiverse id |:---:|:---:|:---:|:---:| |id|Yes|Integer or String| This is the associated multiverse id of the given card. ---- - ## *class* `cards.Mtgo()` Get a card by MTGO id. @@ -104,8 +98,6 @@ Get a card by MTGO id. |:---:|:---:|:---:|:---:| |id|Yes|String|The required mtgo id of the card. ---- - ## *class* `cards.Collector()` Get a card by collector number. @@ -116,8 +108,6 @@ Get a card by collector number. |code|Yes|String|This is the 3 letter code for the set| |collector_number|Yes|String|This is the collector number of the card.| ---- - ## *class* `cards.Id()` Get a card by the Scryfall id. @@ -127,8 +117,6 @@ Get a card by the Scryfall id. |:---:|:---:|:---:|:---:| |id|Yes|String|The Scryfall Id of the card.| ---- - ## *class* `cards.Autocomplete()` Get a list of potential autocompletion phrases. diff --git a/docs/Catalog.md b/docs/Catalog.md index 9ece728..74358ce 100644 --- a/docs/Catalog.md +++ b/docs/Catalog.md @@ -2,7 +2,7 @@ Documentation for a catalog object. 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 (`card.scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`catalog.scryfallJson`). ## Classes All classes accept the following parameters. @@ -14,17 +14,17 @@ All classes accept the following parameters. **Classes** |Name|Description| -|`.ArtifactTypes()`|Returns all unique types of artifacts printed.| -|`.CardNames()`|Returns all unique card names printed.| -|`.CreatureTypes()`|Returns all unique creature types printed.| -|`.LandTypes()`|Returns all unique land types printed.| -|`.Loyalties()`|Returns all unique starting loyalties printed.| -|`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed.| -|`.Powers()`|Returns all unique power values printed.| -|`.SpellTypes()`|Returns all unique spell types printed.| -|`.Toughnesses()`|Returns all unique toughness values printed.| -|`.Watermarks()`|Returns the name of all unique watermarks printed.| -|`.WordBanks()`|Returns all unique words ever printed on a card.| +|`.ArtifactTypes()`|Returns all unique types of artifacts printed. +|`.CardNames()`|Returns all unique card names printed. +|`.CreatureTypes()`|Returns all unique creature types printed. +|`.LandTypes()`|Returns all unique land types printed. +|`.Loyalties()`|Returns all unique starting loyalties printed. +|`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed. +|`.Powers()`|Returns all unique power values printed. +|`.SpellTypes()`|Returns all unique spell types printed. +|`.Toughnesses()`|Returns all unique toughness values printed. +|`.Watermarks()`|Returns the name of all unique watermarks printed. +|`.WordBanks()`|Returns all unique words ever printed on a card. ## Attributes All attributes are listed assuming the following diff --git a/docs/Rulings.md b/docs/Rulings.md index 152fbea..bd24dda 100644 --- a/docs/Rulings.md +++ b/docs/Rulings.md @@ -2,7 +2,7 @@ Documentation for a rulings object. 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 (`card.scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`rulings.scryfallJson`). ## Attributes All attributes are listed assuming the following diff --git a/docs/Sets.md b/docs/Sets.md index 2245f51..0616c6c 100644 --- a/docs/Sets.md +++ b/docs/Sets.md @@ -2,7 +2,7 @@ Documentation for a sets object. 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 (`card.scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`sets.scryfallJson`). ## *class* `Code()` diff --git a/docs/Symbology.md b/docs/Symbology.md index 7824772..24dd8c6 100644 --- a/docs/Symbology.md +++ b/docs/Symbology.md @@ -2,7 +2,7 @@ Documentation for a sets object. 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 (`card.scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`symbology.scryfallJson`). ## *class* `Symbology()`