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

Fixed minor formatting issue

This commit is contained in:
Nanda Scott 2018-10-27 22:56:57 -04:00
parent 026bf18be9
commit 85aa1d4f3b
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Autocomplete.md
View File

@ -7,7 +7,8 @@ These docs will likely not be as detailed as the official Scryfall Documentation
## Args ## Args
|arg|type|description| |arg|type|description|
|:---:|:---:|:---:||q|string|The query of the autocompletion.| |:---:|:---:|:---:|
|q|string|The query of the autocompletion.|
|format|string, optional|Defaults to \'json\'. Returns data in the specified method.| |format|string, optional|Defaults to \'json\'. Returns data in the specified method.|
|face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.| |face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.|
|version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.| |version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
@ -19,7 +20,8 @@ N/A
## Raises ## Raises
|exception type|reason| |exception type|reason|
|:---:|:---:||Exception|If the \'q\' parameter is not provided.| |:---:|:---:|
|Exception|If the \'q\' parameter is not provided.|
|Exception|If the object returned is an error.| |Exception|If the object returned is an error.|
## Examples ## Examples

4
gen_docs.py
View File

@ -4,7 +4,7 @@ from scrython import *
import re import re
def format_args(string, f): def format_args(string, f):
f.write('\n## Args\n\n|arg|type|description|\n|:---:|:---:|:---:|') f.write('\n## Args\n\n|arg|type|description|\n|:---:|:---:|:---:|\n')
arg_list = re.findall(r'(\w*\s*\(\w+[,\s\w]{1,}\):[\w\s\'\\`,.]*[^\w\s\(])', string) arg_list = re.findall(r'(\w*\s*\(\w+[,\s\w]{1,}\):[\w\s\'\\`,.]*[^\w\s\(])', string)
@ -26,7 +26,7 @@ def format_returns(string, f):
def format_raises(string, f): def format_raises(string, f):
f.write('\n## Raises\n\n|exception type|reason|\n|:---:|:---:|') f.write('\n## Raises\n\n|exception type|reason|\n|:---:|:---:|\n')
exception_list = re.findall(r'\w+:[\w\s\\\']+[^\s\w:]', string) exception_list = re.findall(r'\w+:[\w\s\\\']+[^\s\w:]', string)