Documentation

[julianSchwab]

Description of feature

Generate documentation, description of parameters, examples, input, output

[atrigila]

Document the following:

• If a sample fails in the initial checksum validation, do we transfer it in rclone copy or not? Currently we transfer it anyway regardless of the status in the first rclone checksum.
• With the config in rclone that cntains --one-way we have this issue: With this, extra files in the destination that are not in the source will not be detected. This is a design decision but we should document this because it will make the module’s missing_on_src always empty.

[julianSchwab]

Document the following:

• If a sample fails in the initial checksum validation, do we transfer it in rclone copy or not? Currently we transfer it anyway regardless of the status in the first rclone checksum.

I would not copy files which fail in the initial checksum validation as this is an additional signal to the user that something went wrong and prevents continuing with corrupted files.

• With the config in rclone that cntains --one-way we have this issue: With this, extra files in the destination that are not in the source will not be detected. This is a design decision but we should document this because it will make the module’s missing_on_src always empty.

Good catch. I think it can be fine that there are extra files in the destination using this parameter. However, I agree that it should be documented.