Commit b3a3f197 authored by Samuel GAIST's avatar Samuel GAIST

[doc][algorithms] Add class before python method name to fix duplication error

parent 7ee35ecc
Pipeline #44303 passed with stage
in 3 minutes and 23 seconds
......@@ -1009,7 +1009,7 @@ or by iterating over the list:
Additionally, the following method is usable on a **list of inputs**:
.. py:method:: hasMoreData()
.. py:method:: InputList.hasMoreData()
Indicates if there is (at least) another block of data to process on some of
the inputs
......@@ -1022,20 +1022,20 @@ Input
Each input provides the following informations:
.. py:attribute:: name
.. py:attribute:: Input.name
*(string)* Name of the input
.. py:attribute:: data_format
.. py:attribute:: Input.data_format
*(string)* Data format accepted by the input
.. py:attribute:: data_index
.. py:attribute:: Input.data_index
*(integer)* Index of the last block of data received on the input (See section
:ref:`beat-system-algorithms-input-synchronization`)
.. py:attribute:: data
.. py:attribute:: Input.data
*(object)* The last block of data received on the input
......@@ -1140,7 +1140,7 @@ have access to additional methods.
The following method is usable on a **list of inputs**:
.. py:method:: next()
.. py:method:: InputList.next()
Retrieve the next block of data on all the inputs **in a synchronized
manner**
......@@ -1173,11 +1173,11 @@ its inputs, the algorithm would do:
The following methods are usable on an ``input``, in cases where the algorithm
doesn't care about the synchronization of some of its inputs:
.. py:method:: hasMoreData()
.. py:method:: Input.hasMoreData()
Indicates if there is (at least) another block of data available on the input
.. py:method:: next()
.. py:method:: Input.next()
Retrieve the next block of data
......@@ -1336,18 +1336,18 @@ Output
Each output provides the following informations:
.. py:attribute:: name
.. py:attribute:: OutputList.name
*(string)* Name of the output
.. py:attribute:: data_format
.. py:attribute:: OutputList.data_format
*(string)* Format of the data written on the output
And the following method:
.. py:method:: write(data, end_data_index=None)
.. py:method:: OutputList.write(data, end_data_index=None)
Write a block of data on the output
......
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