Skip to content

Commit 1389502

Browse files
authored
Update README.md
1 parent c29a8e7 commit 1389502

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,11 @@ Just frickin
1010
print(joke)
1111
```
1212
bam you got yourself a joke
13+
14+
The `get_joke()` function has multiple optional parameters:
15+
`category` - a list of categories the joke should fit in. Possible entries are "Programming", "Miscellaneous" and "Dark". Leave blank for any.
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"
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"
18+
`type` - what type of joke it is. Defaults to use either. Possible options are "single" and "twopart"
19+
`search_string` - string to search for in jokes. Defaults to None
20+
`id_range` - a list (which should only contain two items) which describes the range in which to search for jokes, by joke id.

0 commit comments

Comments
 (0)