monorail
/
Scrython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs.

This commit is contained in:
Nanda Scott 2018-02-19 17:09:21 -05:00
parent b76e9032d5
commit cc99128914
5 changed files with 15 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Cards.md
View File

@ -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. >Since the `/cards/named` endpoint specifically requires the fuzzy or exact markers, they are required to be explicitly denoted.
---
## *class* `cards.Random()` ## *class* `cards.Random()`
Get a random card. Get a random card.
**Parameters:** **Parameters:**
No parameters are required. No parameters are required.
---
## *class* `cards.Multiverse()` ## *class* `cards.Multiverse()`
Get a card by Multiverse id 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. |id|Yes|Integer or String| This is the associated multiverse id of the given card.
---
## *class* `cards.Mtgo()` ## *class* `cards.Mtgo()`
Get a card by MTGO id. 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. |id|Yes|String|The required mtgo id of the card.
---
## *class* `cards.Collector()` ## *class* `cards.Collector()`
Get a card by collector number. 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| |code|Yes|String|This is the 3 letter code for the set|
|collector_number|Yes|String|This is the collector number of the card.| |collector_number|Yes|String|This is the collector number of the card.|
---
## *class* `cards.Id()` ## *class* `cards.Id()`
Get a card by the Scryfall 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.| |id|Yes|String|The Scryfall Id of the card.|
---
## *class* `cards.Autocomplete()` ## *class* `cards.Autocomplete()`
Get a list of potential autocompletion phrases. Get a list of potential autocompletion phrases.

24
docs/Catalog.md
View File

@ -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. 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 ## Classes
All classes accept the following parameters. All classes accept the following parameters.
@ -14,17 +14,17 @@ All classes accept the following parameters.
**Classes** **Classes**
|Name|Description| |Name|Description|
|`.ArtifactTypes()`|Returns all unique types of artifacts printed.| |`.ArtifactTypes()`|Returns all unique types of artifacts printed.
|`.CardNames()`|Returns all unique card names printed.| |`.CardNames()`|Returns all unique card names printed.
|`.CreatureTypes()`|Returns all unique creature types printed.| |`.CreatureTypes()`|Returns all unique creature types printed.
|`.LandTypes()`|Returns all unique land types printed.| |`.LandTypes()`|Returns all unique land types printed.
|`.Loyalties()`|Returns all unique starting loyalties printed.| |`.Loyalties()`|Returns all unique starting loyalties printed.
|`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed.| |`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed.
|`.Powers()`|Returns all unique power values printed.| |`.Powers()`|Returns all unique power values printed.
|`.SpellTypes()`|Returns all unique spell types printed.| |`.SpellTypes()`|Returns all unique spell types printed.
|`.Toughnesses()`|Returns all unique toughness values printed.| |`.Toughnesses()`|Returns all unique toughness values printed.
|`.Watermarks()`|Returns the name of all unique watermarks printed.| |`.Watermarks()`|Returns the name of all unique watermarks printed.
|`.WordBanks()`|Returns all unique words ever printed on a card.| |`.WordBanks()`|Returns all unique words ever printed on a card.
## Attributes ## Attributes
All attributes are listed assuming the following All attributes are listed assuming the following

2
docs/Rulings.md
View File

@ -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. 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 ## Attributes
All attributes are listed assuming the following All attributes are listed assuming the following

2
docs/Sets.md
View File

@ -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. 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()` ## *class* `Code()`

2
docs/Symbology.md
View File

@ -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. 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()` ## *class* `Symbology()`