Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstrings - inline code docs #59

Open
clausmichele opened this issue Feb 14, 2023 · 1 comment
Open

Docstrings - inline code docs #59

clausmichele opened this issue Feb 14, 2023 · 1 comment

Comments

@clausmichele
Copy link
Member

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
Copy link
Contributor

No real reason other than the combination of:

  • the previous docstrings being outdated in some places and therefore not immediately portable
  • not having docs autogenerated with e.g. sphinx, so the utility being somewhat lower
  • us just not taking the time to do this properly
    I think this is probably something that wants to be added gradually, feel free to add some when it's convenient.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants