The docstrings of the DataGenerator class needs to be improved, as they are not that descriptive.
Good job updating the docstrings of this interface! I approve the merging now.
Nonetheless, I still believe that the Sphinx documentation on this subject must be improved, for instance, when (some generic example) do you actually need the methods add_pre_processing() and add_post_processing?
There are some typos on the Sphinx docs as well: (1) experimentdata.add_post_process(pre_process_function) on the post-processing section, (2) is the execute() meant to be inside the post-processing section?
The docstrings of the
DataGenerator
class needs to be improved, as they are not that descriptive.Nonetheless, I still believe that the Sphinx documentation on this subject must be improved, for instance, when (some generic example) do you actually need the methods add_pre_processing() and add_post_processing?
There are some typos on the Sphinx docs as well: (1)
experimentdata.add_post_process(pre_process_function)
on the post-processing section, (2) is theexecute()
meant to be inside the post-processing section?Originally posted by @BernardoFerreira in https://github.com/bessagroup/f3dasm/pull/204#pullrequestreview-1705067158