Open-EO / openeo-processes-dask

Python implementations of many OpenEO processes, dask-friendly by default.
Apache License 2.0
19 stars 14 forks source link

Docstrings - inline code docs #59

Open clausmichele opened 1 year ago

clausmichele commented 1 year ago

Something that is still missing comparing this repository with the old openeo-processes-python are docstrings, can we consider adding them? Is there a reason why they were not ported over? It could be also useful to point out the openEO processes version we are targeting in each process implementation.

LukeWeidenwalker commented 1 year ago

No real reason other than the combination of:

I'll create an issue to setup docs generation, that's probably a good thing to have at some point.

About the spec version, not entirely sure about that. We could either define a version of openeo that the entire repo targets, or as you propose point it out separately in each process implementation. I feel that one version for all is much less effort for about the same benefit, just because I don't think we'd ever have multiple versions of the same process in this repo. I imagine there's a clever way of versioning/releasing this package to support separate 1.1/1.2/2.0 tracks, but given the maturity of this repo, I don't think this should be a priority anytime soon.