Commit 343c7b61 authored by Tiago Peixoto's avatar Tiago Peixoto

Fix docstring typos

parent 6b062a27
......@@ -8,11 +8,11 @@ as we demonstrate in the following.
.. note::
Since ``graph-tool`` uses `cairo <https://cairographics.org>`_ for
drawing, it is necessary to one of matplotlib's cairo-based backend,
otherwise integration is not possible. Currently, two backends can be
chosen: ``cairo`` or ``GTK3Cairo``. The latter should be chosen for
interactive GUI-based figures. The backend can be changed by calling
:func:`matplotlib.pyplot.switch_backend`:
drawing, it is necessary to use one of matplotlib's cairo-based
backends, otherwise integration is not possible. Currently, two
backends can be chosen: ``cairo`` or ``GTK3Cairo``. The latter should
be chosen for interactive GUI-based figures. The backend can be
changed by calling :func:`matplotlib.pyplot.switch_backend`:
.. code::
......
......@@ -217,7 +217,7 @@ class SIState(EpidemicStateBase):
-----
This implements an SI epidemic process [pastor-satorras-epidemic-2015]_,
where nodes in the susceptible state (value 0) are infectious by neighbours
where nodes in the susceptible state (value 0) are infected by neighbours
in the infectious state (value 1).
If a node :math:`i` is updated at time :math:`t`, the transition
......@@ -325,7 +325,7 @@ class SISState(DiscreteStateBase):
This implements an SIS epidemic process
[pastor-satorras-epidemic-2015]_, where nodes in the susceptible state
(value 0) are infectious by neighbours in the infectious state (value 1),
(value 0) are infected by neighbours in the infectious state (value 1),
which can then eventually recover to a susceptible state.
If a node :math:`i` is updated at time :math:`t`, the transition
......@@ -434,7 +434,7 @@ class SIRState(DiscreteStateBase):
This implements an SIR epidemic process
[pastor-satorras-epidemic-2015]_, where nodes in the susceptible state
(value 0) are infectious by neighbours in the infectious state (value 1),
(value 0) are infected by neighbours in the infectious state (value 1),
which can then eventually recover to a recovered state (value 2).
If a node :math:`i` is updated at time :math:`t`, the transition
......@@ -556,7 +556,7 @@ class SIRSState(DiscreteStateBase):
This implements an SIRS epidemic process
[pastor-satorras-epidemic-2015]_, where nodes in the susceptible state
(value 0) are infectious by neighbours in the infectious state (value 1),
(value 0) are infected by neighbours in the infectious state (value 1),
which can then eventually recover to a recovered state (value 2), and
finally back to the susceptible state.
......
......@@ -523,7 +523,7 @@ class MeasuredBlockState(UncertainBaseState):
positive measurements for each edge.
n_default : ``int`` (optional, default: ``1``)
Total number of measurements for each non-edge.
x_default : ``int`` (optional, default: ``1``)
x_default : ``int`` (optional, default: ``0``)
Total number of positive measurements for each non-edge.
fn_params : ``dict`` (optional, default: ``dict(alpha=1, beta=1)``)
Beta distribution hyperparameters for the probability of missing
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment