From cbff3658d53791b38859f302b74213f484ff444c Mon Sep 17 00:00:00 2001 From: Martin Lange <martin.lange@ufz.de> Date: Mon, 24 Oct 2022 18:05:56 +0200 Subject: [PATCH] fix numbered lists to rst syntax --- docs/source/finam-book/development/adapters.rst | 10 +++++----- docs/source/finam-book/usage/coupling_scripts.rst | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/source/finam-book/development/adapters.rst b/docs/source/finam-book/development/adapters.rst index 163d71e8..fd0f5604 100644 --- a/docs/source/finam-book/development/adapters.rst +++ b/docs/source/finam-book/development/adapters.rst @@ -78,8 +78,8 @@ File ``src/scale.py``: In :meth:`.Adapter._get_data`, we: -1. Pull the input for the requested ``time`` -1. Multiply the input by ``scale`` and return the result +#. Pull the input for the requested ``time`` +#. Multiply the input by ``scale`` and return the result Time-dependent ``TimeInterpolation`` adapter -------------------------------------------- @@ -242,9 +242,9 @@ In :meth:`.Adapter._get_data`, we can now do the interpolation whenever data is In :meth:`.Adapter._get_data`, the following happens: -1. If only one data entry was received so far, we can't interpolate and simply return the available data. Otherwise... -1. Calculate ``dt`` as the relative position of ``time`` in the available data interval (in range [0, 1]) -1. Interpolate and return the data +#. If only one data entry was received so far, we can't interpolate and simply return the available data. Otherwise... +#. Calculate ``dt`` as the relative position of ``time`` in the available data interval (in range [0, 1]) +#. Interpolate and return the data Note that, although we use :class:`datetime <datetime.datetime>` when calculating ``dt``, we get a scalar output. Due to ``dt`` being relative, time units cancel out here. diff --git a/docs/source/finam-book/usage/coupling_scripts.rst b/docs/source/finam-book/usage/coupling_scripts.rst index ae66720c..ae9cc932 100644 --- a/docs/source/finam-book/usage/coupling_scripts.rst +++ b/docs/source/finam-book/usage/coupling_scripts.rst @@ -57,10 +57,10 @@ with a live plotting component (:class:`.modules.TimeSeriesView`). The typical steps in a script are: -1. Instantiate components and adapters (see next example) -2. Create a :class:`.Composition` and initialize it -3. Connect outputs to inputs using the overloaded ``>>`` operator (:meth:`.IOutput.__rshift__`) -4. Run the :class:`.Composition` +#. Instantiate components and adapters (see next example) +#. Create a :class:`.Composition` and initialize it +#. Connect outputs to inputs using the overloaded ``>>`` operator (:meth:`.IOutput.__rshift__`) +#. Run the :class:`.Composition` Inputs and outputs ------------------ @@ -143,8 +143,8 @@ As can be seen from the example, components and adapters can be chained using th This is achieved by: -1. An adapter is an input, and at the same time an output -2. The chained input is returned by `>>` and :meth:`.IOutput.chain`. In case the chained input is an adapter (and thus also an output), it can be immediately reused in a further chaining operation +#. An adapter is an input, and at the same time an output +#. The chained input is returned by `>>` and :meth:`.IOutput.chain`. In case the chained input is an adapter (and thus also an output), it can be immediately reused in a further chaining operation Logging ------- -- GitLab