summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSviatoslav Sydorenko <wk@sydorenko.org.ua>2018-01-13 02:40:20 +0200
committerSviatoslav Sydorenko <wk@sydorenko.org.ua>2018-01-13 02:44:41 +0200
commit5c6cc5dc5a18511eb7d2ebde16ec49cd93cb3938 (patch)
treec8b28faf31e23331de7e41a2f072621463e619b1
parent2d78e0571ff24870c6fe8a1a63c1ed24c1b4a7f6 (diff)
downloadcherrypy-git-5c6cc5dc5a18511eb7d2ebde16ec49cd93cb3938.tar.gz
Fix Sphinx complaints regarding bullet list fmt
-rw-r--r--docs/extend.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/extend.rst b/docs/extend.rst
index 56eb9859..600c9bf7 100644
--- a/docs/extend.rst
+++ b/docs/extend.rst
@@ -198,18 +198,26 @@ In order to work with the bus, the implementation
provides the following simple API:
- :meth:`cherrypy.engine.publish(channel, *args) <cherrypy.process.wspbus.Bus.publish>`:
+
- The `channel` parameter is a string identifying the channel to
which the message should be sent to
+
- `*args` is the message and may contain any valid Python values or
objects.
+
- :meth:`cherrypy.engine.subscribe(channel, callable) <cherrypy.process.wspbus.Bus.subscribe>`:
+
- The `channel` parameter is a string identifying the channel the
`callable` will be registered to.
+
- `callable` is a Python function or method which signature must
match what will be published.
+
- :meth:`cherrypy.engine.unsubscribe(channel, callable) <cherrypy.process.wspbus.Bus.unsubscribe>`:
+
- The `channel` parameter is a string identifying the channel the
`callable` was registered to.
+
- `callable` is the Python function or method which was registered.
.. _busplugins: