Skip to content

Commit f6fffab

Browse files
committed
Fixed doc gen issues
1 parent a77c84a commit f6fffab

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/api/recipient_lists.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. module:: sparkpost.recipient_lists
22

33
:mod:`sparkpost.recipient_lists`
4-
=============================
4+
================================
55

66
.. autoclass:: RecipientLists
77
:members:

docs/resources/recipient_lists.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Recipient Lists
2-
=============
2+
===============
33

44
Let's use the underlying `recipient_lists API`_ to create a recipient list:
55

@@ -38,7 +38,7 @@ Let's use the underlying `recipient_lists API`_ to create a recipient list:
3838

3939

4040
Retrieve a recipient list
41-
-----------------------
41+
-------------------------
4242

4343
.. code-block:: python
4444
@@ -50,7 +50,7 @@ Retrieve a recipient list
5050
5151
5252
List all recipient lists
53-
----------------------
53+
------------------------
5454

5555
.. code-block:: python
5656
@@ -78,6 +78,6 @@ See the `python-sparkpost recipient_lists examples`_.
7878
Additional documentation
7979
------------------------
8080

81-
See the `SparkPost Recipient List API Reference`_.
81+
See the `SparkPost Recipient Lists API Reference`_.
8282

8383
.. _SparkPost Recipient Lists API Reference: https://www.sparkpost.com/api#/reference/recipient_lists

sparkpost/recipient_lists.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
class RecipientLists(Resource):
77
"""
88
RecipientLists class used to create, update, delete, list and get recipient
9-
lists. For
10-
detailed request and response formats, see the `Recipient Lists API
11-
documentation <https://www.sparkpost.com/api#/reference/recipient-lists>`_.
9+
lists. For detailed request and response formats, see the `Recipient Lists
10+
API documentation
11+
<https://www.sparkpost.com/api#/reference/recipient-lists>`_.
1212
"""
1313

1414
key = 'recipient-lists'
@@ -68,7 +68,7 @@ def delete(self, list_id):
6868
6969
:param str list_id: ID of the recipient list you want to delete
7070
71-
:returns: TODO
71+
:returns: empty ``dict``
7272
:raises: :exc:`SparkPostAPIException` if recipient list is not found
7373
or if recipient list is in use
7474
"""

0 commit comments

Comments
 (0)