VisionSystemsInc / VisionSystemsInc/terra

sphinx error for AlreadyRunException

Open
#95 0 comments 0 reactions 1 assignee View on GitHub

@andyneff is already working on this.

Since Mar 24, 2021.

Dominant language
Python
Stars
2
Forks
3
Avg merge
22m
Merged PRs (30d)
1

Description

Sphinx is throwing a new error in downstream repos like terra_dsm:

/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.CropAndCalibrate:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.DSMFusion:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.DSMFusion4D:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.FeatureMatching:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.GeocorrectionDirect:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.GraphSolver:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.ImageDatabaseCreation:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.PostProcessing:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.StereoDSMGeneration:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.TileCreation:: WARNING: py:exc reference target not found: AlreadyRunException

This appears to be coming from the resumable decorator docstring
https://github.com/VisionSystemsInc/terra/blob/55b1ce95705be6bc75f3008879e7e6b4f5a8458e/terra/utils/workflow.py#L43-L46

Maybe the following would fix it (calling out the full exception path)?

  Raises
  ------
  terra.utils.workflow.AlreadyRunException
      Thrown when function attempts to run a second time.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.