Skip to content

[codex] clarify UDF signature annotations#907

Draft
therealclvn wants to merge 1 commit into
Open-EO:masterfrom
therealclvn:codex/udf-type-annotation-docs
Draft

[codex] clarify UDF signature annotations#907
therealclvn wants to merge 1 commit into
Open-EO:masterfrom
therealclvn:codex/udf-type-annotation-docs

Conversation

@therealclvn

Copy link
Copy Markdown

Closes #757.

What changed

  • Clarified in the UDF signatures section that the function name and Python type annotations are part of the UDF entrypoint signature.
  • Added a short unannotated vs annotated apply_datacube example so users can translate the rendered Sphinx signature back to Python code.
  • Added a changelog entry for the documentation fix.

Validation

  • git diff --check
  • Parsed the added Python code examples with ast.parse.

Note: I did not run a full Sphinx docs build because Sphinx is not installed in the available local Python environments.

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

Successfully merging this pull request may close these issues.

UDF docs: clarify that type annotations are important

1 participant