Open-EO / Open-EO/openeo-python-client

Docs: Type annotation reference issues

Open
#307 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

current sphinx build has these warnings:

WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.datacube.DataCube.execute_local_udf": name 'xarray' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.vectorcube.VectorCube": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.mlmodel.MlModel": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.mlmodel.MlModel.load_ml_model": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.job.BatchJob": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.job.RESTJob": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.conversions.datacube_from_file": name 'XarrayDataCube' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.conversions.datacube_plot": name 'XarrayDataCube' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.conversions.datacube_to_file": name 'XarrayDataCube' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.rest.udp.RESTUserDefinedProcess": name 'Connection' is not defined
WARNING: Cannot resolve forward reference in type annotations of "openeo.udf.xarraydatacube.XarrayDataCube.plot": name 'matplotlib' is not defined

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the current Sphinx build and inspect the modules and objects named in the warnings, including DataCube.execute_local_udf, VectorCube, MlModel, BatchJob, RESTJob, the conversion functions, RESTUserDefinedProcess, XarrayDataCube.plot, and their referenced annotations. The work is done when the build completes without these unresolved type-annotation warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.