Skip to content

Commit 71a70e2

Browse files
authored
Update README.md
1 parent ff5cbf7 commit 71a70e2

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ Just frickin
1111
```
1212
bam you got yourself a joke
1313

14-
The `get_joke()` function has multiple optional parameters:\n\n
15-
`category` - a list of categories the joke should fit in. Possible entries are "Programming", "Miscellaneous" and "Dark". Leave blank for any.\n
16-
`blacklist` - a list of things you don't *really* want to see. Maybe you're babysitting. Possible entries are "nsfw", "religious", "political", "racist" and "sexist"\n
17-
`response_format` - a string which describes what format you want your response in. Default is json, and it will return a dict. Other options are "xml" and "yaml"\n
18-
`type` - what type of joke it is. Defaults to use either. Possible options are "single" and "twopart"\n
19-
`search_string` - string to search for in jokes. Defaults to None\n
20-
`id_range` - a list (which should only contain two items) which describes the range in which to search for jokes, by joke id.\n
14+
The `get_joke()` function has multiple optional parameters:
15+
16+
17+
`category` - a list of categories the joke should fit in. Possible entries are "Programming", "Miscellaneous" and "Dark". Leave blank for any.
18+
19+
`blacklist` - a list of things you don't *really* want to see. Maybe you're babysitting. Possible entries are "nsfw", "religious", "political", "racist" and "sexist"
20+
21+
`response_format` - a string which describes what format you want your response in. Default is json, and it will return a dict. Other options are "xml" and "yaml"
22+
23+
`type` - what type of joke it is. Defaults to use either. Possible options are "single" and "twopart"
24+
25+
`search_string` - string to search for in jokes. Defaults to None
26+
27+
`id_range` - a list (which should only contain two items) which describes the range in which to search for jokes, by joke id.
28+

0 commit comments

Comments
 (0)