Skip to content
Snippets Groups Projects
Commit f6a3be99 authored by Samuel GAIST's avatar Samuel GAIST
Browse files

[documentation] Change Prefix to string in documentation of various classes

parent 8b2f3767
Branches
Tags
1 merge request!17Merge development branch 1.5.x
Pipeline #
...@@ -334,8 +334,7 @@ class CachedDataSource(DataSource): ...@@ -334,8 +334,7 @@ class CachedDataSource(DataSource):
filename (str): Name of the file to read the data from filename (str): Name of the file to read the data from
prefix (beat.backend.python.utils.Prefix): Establishes the prefix of prefix (str): Establishes the prefix of your installation.
your installation.
start_index (int): The starting index (if not set or set to start_index (int): The starting index (if not set or set to
``None``, the default, read data from the begin of file) ``None``, the default, read data from the begin of file)
...@@ -522,8 +521,7 @@ class DatabaseOutputDataSource(DataSource): ...@@ -522,8 +521,7 @@ class DatabaseOutputDataSource(DataSource):
Parameters: Parameters:
prefix (beat.backend.python.utils.Prefix): Establishes the prefix of prefix (str): Establishes the prefix of your installation.
your installation.
start_index (int): The starting index (if not set or set to start_index (int): The starting index (if not set or set to
``None``, the default, read data from the begin of file) ``None``, the default, read data from the begin of file)
...@@ -612,7 +610,7 @@ class DatabaseOutputDataSource(DataSource): ...@@ -612,7 +610,7 @@ class DatabaseOutputDataSource(DataSource):
d.from_dict(data, casting='safe', add_defaults=False) d.from_dict(data, casting='safe', add_defaults=False)
data = d data = d
if self.pack: if self.pack:
data = data.pack() data = data.pack()
self.nb_bytes_read += len(data) self.nb_bytes_read += len(data)
...@@ -646,8 +644,7 @@ class RemoteDataSource(DataSource): ...@@ -646,8 +644,7 @@ class RemoteDataSource(DataSource):
dataformat_name (str): Name of the data format. dataformat_name (str): Name of the data format.
prefix (beat.backend.python.utils.Prefix): Establishes the prefix of prefix (str): Establishes the prefix of your installation.
your installation.
unpack (bool): Indicates if the data must be unpacked or not unpack (bool): Indicates if the data must be unpacked or not
......
...@@ -46,8 +46,7 @@ class DBExecutor(object): ...@@ -46,8 +46,7 @@ class DBExecutor(object):
Parameters: Parameters:
prefix (beat.backend.python.utils.Prefix): Establishes the prefix of prefix (str): Establishes the prefix of your installation.
your installation.
data (dict, str): The piece of data representing the block to be executed. data (dict, str): The piece of data representing the block to be executed.
It must validate against the schema defined for execution blocks. If a It must validate against the schema defined for execution blocks. If a
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment