Tiff tasks parameter `folder` renamed to `path`

sentinel-hub / eo-learn

Earth observation processing framework for machine learning in Python

https://eo-learn.readthedocs.io/en/latest/

MIT License

1.13k stars 300 forks source link

Closed zigaLuksic closed 12 months ago

zigaLuksic commented 1 year ago

It's often not a folder, so it's very confusing...

Ellipsis as a default seemed like the best way to signal that this might still be required (using None would be odd).

TiffTask(feature, my_path) works as before
TiffTask(feature) will raise a TypeError that the parameter path is missing (similar to what would happen before)
TiffTask(feature, path=my_path) works as intended
TiffTask(feature, folder=my_path) also works as previously intended, but also warns the user

zigaLuksic commented 12 months ago

thanks for the new docstrings, much clearer :bow: