From 00e0e09fa93d9ee67cf482b611efb490838932ea Mon Sep 17 00:00:00 2001 From: Nanda Scott Date: Mon, 5 Feb 2018 20:52:00 -0500 Subject: [PATCH] Adding Rulings.md and removing the garbage file. --- docs/Rulings.md | 30 ++++++++++++++++++++++++++++++ docs/garbage | 1 - 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/Rulings.md delete mode 100644 docs/garbage diff --git a/docs/Rulings.md b/docs/Rulings.md new file mode 100644 index 0000000..20f0124 --- /dev/null +++ b/docs/Rulings.md @@ -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.()` 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}." diff --git a/docs/garbage b/docs/garbage deleted file mode 100644 index 1190fd0..0000000 --- a/docs/garbage +++ /dev/null @@ -1 +0,0 @@ -This is a garbage file for git to track this directory.