Skip to content

Commit

Permalink
Fix docstring syntax of PubSub functions for Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
ntninja committed May 27, 2018
1 parent 6cc1369 commit e337488
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions ipfsapi/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2281,6 +2281,7 @@ def pubsub_peers(self, topic=None, **kwargs):
topic will be returned in the data.
.. code-block:: python
>>> c.pubsub_peers()
{'Strings':
[
Expand Down Expand Up @@ -2329,6 +2330,7 @@ def pubsub_pub(self, topic, payload, **kwargs):
base64 encoded when published.
.. code-block:: python
# publishes the message 'message' to the topic 'hello'
>>> c.pubsub_pub('hello', 'message')
[]
Expand Down Expand Up @@ -2360,6 +2362,7 @@ def pubsub_sub(self, topic, discover=False, **kwargs):
hanging.
.. code-block:: python
>>> sub = c.pubsub_sub('testing')
>>> with c.pubsub_sub('testing') as sub:
# publish a message 'hello' to the topic 'testing'
Expand Down

0 comments on commit e337488

Please sign in to comment.