Skip to content

Commit 2cc30ec

Browse files
authored
📝Correct readme
1 parent fb71aa5 commit 2cc30ec

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If left blank it will default to use `Any`.
5252
##### Example
5353

5454
```python
55-
joke = get_joke(categories=['programming', 'dark']) # Will return a joke that fits in either the programming or dark category.
55+
joke = j.get_joke(category=['programming', 'dark']) # Will return a joke that fits in either the programming or dark category.
5656
```
5757

5858
---
@@ -72,7 +72,7 @@ If left blank it will default to `None`.
7272
##### Example
7373

7474
```python
75-
joke = get_joke(blacklist=['nsfw', 'racist']) # Will return a joke that does not have either the flag "nsfw" or "racist".
75+
joke = j.get_joke(blacklist=['nsfw', 'racist']) # Will return a joke that does not have either the flag "nsfw" or "racist".
7676
```
7777

7878
---
@@ -91,7 +91,7 @@ If left blank it will default to `json`.
9191
#### Example
9292

9393
```python
94-
joke = get_joke(response_format="xml") # Will return a joke in xml format.
94+
joke = j.get_joke(response_format="xml") # Will return a joke in xml format.
9595
```
9696

9797
---
@@ -108,7 +108,7 @@ If left blank it will default to `Any`
108108
#### Example
109109

110110
```python
111-
joke = get_joke(type="twopart") # Will return a twopart joke; both a setup and a delivery.
111+
joke = j.get_joke(type="twopart") # Will return a twopart joke; both a setup and a delivery.
112112
```
113113

114114
---
@@ -122,7 +122,7 @@ If left blank it will default to `None`
122122
#### Example
123123

124124
```python
125-
joke = get_joke(search_string="the") # Will return a joke with the word "the" in it.
125+
joke = j.get_joke(search_string="the") # Will return a joke with the word "the" in it.
126126
# If there are no jokes then it will return the error from the API.
127127
```
128128

@@ -140,7 +140,7 @@ If left blank it will default to the maximum range.
140140
#### Example
141141

142142
```python
143-
joke = get_joke(id_range=[10,100]) # Will return a joke with the ID between 10 and 100.
143+
joke = j.get_joke(id_range=[10,100]) # Will return a joke with the ID between 10 and 100.
144144
```
145145

146146
---
@@ -154,7 +154,7 @@ more requests than normal users. Defaults to None
154154
#### Example
155155

156156
```python
157-
joke = get_joke(auth_token="aaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbb") # Will send the token to the api in a header.
157+
joke = j.get_joke(auth_token="aaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbb") # Will send the token to the api in a header.
158158
```
159159

160160
---
@@ -169,7 +169,7 @@ to change it
169169
#### Example
170170

171171
```python
172-
joke = get_joke(user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:77.0) Gecko/20100101 Firefox/77.0")
172+
joke = j.get_joke(user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:77.0) Gecko/20100101 Firefox/77.0")
173173
# This is in fact the default user agent, and tells the API that we are visitng the page from a Firefox 77.0
174174
# browser using Windows 10 64bit.
175175
```
@@ -185,7 +185,7 @@ Defaults to False.
185185
#### Example
186186

187187
```python
188-
response = get_joke(return_headers=True)
188+
response = j.get_joke(return_headers=True)
189189
joke = response[0]
190190
headers = response[1]
191191
# The function returns the joke and then the headers using the "return x, y" syntax, so you can index it like a list or tuple.

0 commit comments

Comments
 (0)