Skip to content

Commit

Permalink
Fix invalid reST in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jtackaberry committed May 11, 2012
1 parent 43bbcb0 commit 5a768ad
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/main.py
Expand Up @@ -374,6 +374,7 @@ def step(*args, **kwargs):
Performs a single iteration of the main loop.
.. warning::
This function should almost certainly never be called directly. Use it
at your own peril. (If you do use it, you must call
:func:`~kaa.main.init` first.)
Expand Down
1 change: 1 addition & 0 deletions src/net/tls/openssl.py
Expand Up @@ -1933,6 +1933,7 @@ def verify(self, cert, depth, err, errmsg):
:meth:`starttls_client`)
.. note::
Subclasses may override this method to implement custom verification
behaviour, but it may be more convenient to set the
:attr:`verify_cb` property with a callback.
Expand Down
2 changes: 1 addition & 1 deletion src/process.py
Expand Up @@ -584,14 +584,14 @@ def start(self, args=''):
active.
.. warning::
If :meth:`~kaa.InProgress.timeout` is called on the returned
InProgress and the timeout occurs, the InProgress returned by
:meth:`start` will be finished with a :class:`~kaa.TimeoutException`
even though the child process isn't actually dead. You can always
test the :attr:`running` property, or use the
:attr:`~signals.finished` signal, which doesn't emit until the child
process is genuinely dead.
"""
if self._child and self._state != Process.STATE_HUNG:
raise IOError(errno.EEXIST, 'Child process has already been started')
Expand Down

0 comments on commit 5a768ad

Please sign in to comment.