Adding Rulings.md and removing the garbage file.

This commit is contained in:
Nanda Scott 2018-02-05 20:52:00 -05:00
parent c8c847e0b7
commit 00e0e09fa9
2 changed files with 30 additions and 1 deletions

30
docs/Rulings.md Normal file
View File

@ -0,0 +1,30 @@
# Rulings
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`).
## Attributes
All attributes are listed assuming the following
`rule = scrython.rulings.<Class>()` is the current usage.
## `rule.object()`
str | Returns the type of object it is. (card, error, etc)
## `rule.has_more()`
|Name|Data type returned|Description|
|:---:|:---:|:---:|
|`object()`|String|Returns the type of object it is. (card, error, etc)|
|`had_more()`|Bool| If true, this ruling object has more rules than it currently displays.|
|`data()`|List|A list of ruling objects.
|`data_length()`|Integer|The length of the `data` list.|
|`ruling_object()`|String|The type of object for a given ruling. Requires an integer as a parameter, which acts as a tuple.|
|`ruling_source()`|String|The source of the ruling. Requires an integer as a parameter, which acts as a tuple.|
|`ruling_published_at()`|String|The date when the ruling was published. Requires an integer as a parameter, which acts as a tuple.|
|`ruling_comment()`|String|The effective ruling. Requires an integer as a parameter, which acts as a tuple.|
Example usage:
rule = scrython.rulings.Id(id="0f91d225-788e-42fc-9d01-8668f672b717")
rule.ruling_comment(5)
>>>"If you control multiple As Foretolds, you may cast one spell for each of them paying {0}."

View File

@ -1 +0,0 @@
This is a garbage file for git to track this directory.