Skip to content

Commit 6d3ec99

Browse files
jasdevjasdev
committed
redoing function headers
1 parent e401319 commit 6d3ec99

1 file changed

Lines changed: 78 additions & 234 deletions

File tree

‎README.md‎

Lines changed: 78 additions & 234 deletions
Original file line numberDiff line numberDiff line change
@@ -97,262 +97,106 @@ Error types
9797

9898
### Account
9999

100-
* ```python
101-
get_account(username)
102-
```
103-
* ```python
104-
get_gallery_favorites(username)
105-
```
106-
* ```python
107-
get_account_favorites(username)
108-
```
109-
* ```python
110-
get_account_submissions(username, page=0)
111-
```
112-
* ```python
113-
get_account_settings(username)
114-
```
115-
* ```python
116-
change_account_settings(username, fields)
117-
```
118-
* ```python
119-
get_email_verification_status(username)
120-
```
121-
* ```python
122-
send_verification_email(username)
123-
```
124-
* ```python
125-
get_account_albums(username, page=0)
126-
```
127-
* ```python
128-
get_account_album_ids(username, page=0)
129-
```
130-
* ```python
131-
get_account_album_count(username)
132-
```
133-
* ```python
134-
get_account_comments(username, sort='newest', page=0)
135-
```
136-
* ```python
137-
get_account_comment_ids(username, sort='newest', page=0)
138-
```
139-
* ```python
140-
get_account_comment_count(username)
141-
```
142-
* ```python
143-
get_account_images(username, page=0)
144-
```
145-
* ```python
146-
get_account_image_ids(username, page=0)
147-
```
148-
* ```python
149-
get_account_album_count(username)
150-
```
100+
* `get_account(username)`
101+
* `get_gallery_favorites(username)`
102+
* `get_account_favorites(username)`
103+
* `get_account_submissions(username, page=0)`
104+
* `get_account_settings(username)`
105+
* `change_account_settings(username, fields)`
106+
* `get_email_verification_status(username)`
107+
* `send_verification_email(username)`
108+
* `get_account_albums(username, page=0)`
109+
* `get_account_album_ids(username, page=0)`
110+
* `get_account_album_count(username)`
111+
* `get_account_comments(username, sort='newest', page=0)`
112+
* `get_account_comment_ids(username, sort='newest', page=0)`
113+
* `get_account_comment_count(username)`
114+
* `get_account_images(username, page=0)`
115+
* `get_account_image_ids(username, page=0)`
116+
* `get_account_album_count(username)`
151117

152118
### Album
153-
* ```python
154-
get_album(album_id)
155-
```
156-
* ```python
157-
get_album_images(album_id)
158-
```
159-
* ```python
160-
create_album(fields)
161-
```
162-
* ```python
163-
update_album(album_id, fields)
164-
```
165-
* ```python
166-
album_delete(album_id)
167-
```
168-
* ```python
169-
album_favorite(album_id)
170-
```
171-
* ```python
172-
album_set_images(album_id, ids)
173-
```
174-
* ```python
175-
album_add_images(album_id, ids)
176-
```
177-
* ```python
178-
album_remove_images(album_id, ids)
179-
```
119+
* `get_album(album_id)`
120+
* `get_album_images(album_id)`
121+
* `create_album(fields)`
122+
* `update_album(album_id, fields)`
123+
* `album_delete(album_id)`
124+
* `album_favorite(album_id)`
125+
* `album_set_images(album_id, ids)`
126+
* `album_add_images(album_id, ids)`
127+
* `album_remove_images(album_id, ids)`
180128

181129
### Comment
182-
* ```python
183-
get_comment(comment_id)
184-
```
185-
* ```python
186-
delete_comment(comment_id)
187-
```
188-
* ```python
189-
create_album(fields)
190-
```
191-
* ```python
192-
get_comment_replies(comment_id)
193-
```
194-
* ```python
195-
post_comment_reply(comment_id, image_id, comment)
196-
```
197-
* ```python
198-
comment_vote(comment_id, vote='up')
199-
```
200-
* ```python
201-
comment_report(comment_id)
202-
```
130+
* `get_comment(comment_id)`
131+
* `delete_comment(comment_id)`
132+
* `create_album(fields)`
133+
* `get_comment_replies(comment_id)`
134+
* `post_comment_reply(comment_id, image_id, comment)`
135+
* `comment_vote(comment_id, vote='up')`
136+
* `comment_report(comment_id)`
203137

204138
### Custom Gallery
205139

206-
* ```python
207-
get_custom_gallery(gallery_id, sort='viral', window='week', page=0)
208-
```
209-
* ```python
210-
get_user_galleries()
211-
```
212-
* ```python
213-
create_custom_gallery(name, tags=None)
214-
```
215-
* ```python
216-
custom_gallery_update(gallery_id, name)
217-
```
218-
* ```python
219-
custom_gallery_add_tags(gallery_id, tags)
220-
```
221-
* ```python
222-
custom_gallery_remove_tags(gallery_id, tags)
223-
```
224-
* ```python
225-
custom_gallery_delete(gallery_id)
226-
```
227-
* ```python
228-
filtered_out_tags()
229-
```
230-
* ```python
231-
block_tag(tag)
232-
```
233-
* ```python
234-
unblock_tag(tag)
235-
```
140+
* `get_custom_gallery(gallery_id, sort='viral', window='week', page=0)`
141+
* `get_user_galleries()`
142+
* `create_custom_gallery(name, tags=None)`
143+
* `custom_gallery_update(gallery_id, name)`
144+
* `custom_gallery_add_tags(gallery_id, tags)`
145+
* `custom_gallery_remove_tags(gallery_id, tags)`
146+
* `custom_gallery_delete(gallery_id)`
147+
* `filtered_out_tags()`
148+
* `block_tag(tag)`
149+
* `unblock_tag(tag)`
236150

237151
### Gallery
238152

239-
* ```python
240-
gallery(section='hot', sort='viral', page=0, window='day', show_viral=True)
241-
```
242-
* ```python
243-
memes_subgallery(sort='viral', page=0, window='week')
244-
```
245-
* ```python
246-
memes_subgallery_image(item_id)
247-
```
248-
* ```python
249-
subreddit_gallery(subreddit, sort='time', window='week', page=0)
250-
```
251-
* ```python
252-
subreddit_image(subreddit, image_id)
253-
```
254-
* ```python
255-
gallery_tag(tag, sort='viral', page=0, window='week')
256-
```
257-
* ```python
258-
gallery_tag_image(tag, item_id)
259-
```
260-
* ```python
261-
gallery_item_tags(item_id)
262-
```
263-
* ```python
264-
gallery_tag_vote(item_id, tag, vote)
265-
```
266-
* ```python
267-
gallery_search(q, advanced=None, sort='time', window='all', page=0)
268-
```
269-
* ```python
270-
gallery_random(page=0)
271-
```
272-
* ```python
273-
share_on_imgur(item_id, title, terms=1)
274-
```
275-
* ```python
276-
remove_from_gallery(item_id)
277-
```
278-
* ```python
279-
gallery_item(item_id)
280-
```
281-
* ```python
282-
report_gallery_item(item_id)
283-
```
284-
* ```python
285-
gallery_item_vote(item_id, vote='up')
286-
```
287-
* ```python
288-
gallery_item_comments(item_id, sort='best')
289-
```
290-
* ```python
291-
gallery_comment(item_id, comment)
292-
```
293-
* ```python
294-
gallery_comment_ids(item_id)
295-
```
296-
* ```python
297-
gallery_comment_count(item_id)
298-
```
153+
* `gallery(section='hot', sort='viral', page=0, window='day', show_viral=True)`
154+
* `memes_subgallery(sort='viral', page=0, window='week')`
155+
* `memes_subgallery_image(item_id)`
156+
* `subreddit_gallery(subreddit, sort='time', window='week', page=0)`
157+
* `subreddit_image(subreddit, image_id)`
158+
* `gallery_tag(tag, sort='viral', page=0, window='week')`
159+
* `gallery_tag_image(tag, item_id)`
160+
* `gallery_item_tags(item_id)`
161+
* `gallery_tag_vote(item_id, tag, vote)`
162+
* `gallery_search(q, advanced=None, sort='time', window='all', page=0)`
163+
* `gallery_random(page=0)`
164+
* `share_on_imgur(item_id, title, terms=1)`
165+
* `remove_from_gallery(item_id)`
166+
* `gallery_item(item_id)`
167+
* `report_gallery_item(item_id)`
168+
* `gallery_item_vote(item_id, vote='up')`
169+
* `gallery_item_comments(item_id, sort='best')`
170+
* `gallery_comment(item_id, comment)`
171+
* `gallery_comment_ids(item_id)`
172+
* `gallery_comment_count(item_id)`
299173

300174
### Image
301175

302-
* ```python
303-
get_image(image_id)
304-
```
305-
* ```python
306-
upload_from_path(path, config=None, anon=True)
307-
```
308-
* ```python
309-
upload_from_url(url, config=None, anon=True)
310-
```
311-
* ```python
312-
delete_image(image_id)
313-
```
314-
* ```python
315-
favorite_image(image_id)
316-
```
176+
* `get_image(image_id)`
177+
* `upload_from_path(path, config=None, anon=True)`
178+
* `upload_from_url(url, config=None, anon=True)`
179+
* `delete_image(image_id)`
180+
* `favorite_image(image_id)`
317181

318182
### Conversation
319183

320-
* ```python
321-
conversation_list()
322-
```
323-
* ```python
324-
get_conversation(conversation_id, page=1, offset=0)
325-
```
326-
* ```python
327-
create_message(recipient, body)
328-
```
329-
* ```python
330-
delete_conversation(conversation_id)
331-
```
332-
* ```python
333-
report_sender(username)
334-
```
335-
* ```python
336-
block_sender(username)
337-
```
184+
* `conversation_list()`
185+
* `get_conversation(conversation_id, page=1, offset=0)`
186+
* `create_message(recipient, body)`
187+
* `delete_conversation(conversation_id)`
188+
* `report_sender(username)`
189+
* `block_sender(username)`
338190

339191
### Notification
340192

341-
* ```python
342-
get_notifications(new=True)
343-
```
344-
* ```python
345-
get_notification(notification_id)
346-
```
347-
* ```python
348-
mark_notifications_as_read(notification_ids)
349-
```
193+
* `get_notifications(new=True)`
194+
* `get_notification(notification_id)`
195+
* `mark_notifications_as_read(notification_ids)`
350196

351197
### Memegen
352198

353-
* ```python
354-
default_memes()
355-
```
199+
* `default_memes()`
356200

357201
Command Line Usage (deprecated)
358202
------------

0 commit comments

Comments
 (0)