Skip to content

Commit

Permalink
Doc: Fix some bad Sphinx roles (#424)
Browse files Browse the repository at this point in the history
* Fix some bad Sphinx roles

* Update docs/source/guide/intro.rst

* Fix one more missing substitution
  • Loading branch information
mdickinson committed Jul 16, 2021
1 parent b437bad commit 288a576
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/source/guide/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ We'll examine the future objects in the next section. This section deals with
the executor's main top-level methods and the task submission functions.

To submit a task, use one of the convenience submission functions available
from :mod:`traits_futures.api`:
from |traits_futures.api|:

- The |submit_call| function allows submission of a simple Python callable,
with given positional and named arguments. For example::
Expand Down Expand Up @@ -183,7 +183,7 @@ you might use this as follows::
self.my_results.append(future.result)

Any attempt to access the future's |result| before the future completes
successfully will raise an :exc:`AttributeError`. This includes the cases where
successfully will raise an |AttributeError|. This includes the cases where
the background task was cancelled, or failed with an exception, as well
as the cases where the task is still executing or has yet to start running.

Expand Down Expand Up @@ -369,17 +369,17 @@ needed.
.. |stop| replace:: :meth:`~traits_futures.traits_executor.TraitsExecutor.stop`

.. |executor_state| replace:: :attr:`~traits_futures.traits_executor.TraitsExecutor.state`
.. |ExecutorState| replace:: :meth:`~traits_futures.executor_states.ExecutorState`
.. |ExecutorState| replace:: :data:`~traits_futures.executor_states.ExecutorState`
.. |RUNNING| replace:: :data:`~traits_futures.executor_states.RUNNING`
.. |STOPPING| replace:: :data:`~traits_futures.executor_states.STOPPING`
.. |STOPPED| replace:: :data:`~traits_futures.executor_states.STOPPED`

.. |cancel| replace:: :meth:`~traits_futures.i_future.IFuture.cancel`
.. |cancellable| replace:: :attr:`~traits_futures.i_future.IFuture.cancellable`
.. |done| replace:: :meth:`~traits_futures.i_future.IFuture.done`
.. |future_state| replace:: :meth:`~traits_futures.i_future.IFuture.state`
.. |result| replace:: :meth:`~traits_futures.i_future.IFuture.result`
.. |exception| replace:: :meth:`~traits_futures.i_future.IFuture.exception`
.. |done| replace:: :attr:`~traits_futures.i_future.IFuture.done`
.. |future_state| replace:: :attr:`~traits_futures.i_future.IFuture.state`
.. |result| replace:: :attr:`~traits_futures.i_future.IFuture.result`
.. |exception| replace:: :attr:`~traits_futures.i_future.IFuture.exception`

.. |CallFuture| replace:: :class:`~traits_futures.background_call.CallFuture`
.. |submit_call| replace:: :func:`~traits_futures.background_call.submit_call`
Expand Down

0 comments on commit 288a576

Please sign in to comment.