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

Sphinx Docs warning #136

Open
ZohebShaikh opened this issue Aug 13, 2024 · 1 comment
Open

Sphinx Docs warning #136

ZohebShaikh opened this issue Aug 13, 2024 · 1 comment

Comments

@ZohebShaikh
Copy link
Contributor

The docs is giving this warning

/home/runner/work/scanspec/scanspec/src/scanspec/specs.py:docstring of scanspec.specs.Repeat:1: WARNING: py:class reference target not found: annotated_types.Ge [ref.class]
/home/runner/work/scanspec/scanspec/src/scanspec/specs.py:docstring of scanspec.specs.Line:1: WARNING: py:class reference target not found: annotated_types.Ge [ref.class]
/home/runner/work/scanspec/scanspec/src/scanspec/specs.py:docstring of scanspec.specs.Static:1: WARNING: py:class reference target not found: annotated_types.Ge [ref.class]
/home/runner/work/scanspec/scanspec/src/scanspec/regions.py:docstring of scanspec.regions.Polygon:1: WARNING: py:class reference target not found: annotated_types.MinLen [ref.class]
/home/runner/work/scanspec/scanspec/src/scanspec/regions.py:docstring of scanspec.regions.Polygon:1: WARNING: py:class reference target not found: annotated_types.MinLen [ref.class]
/home/runner/work/scanspec/scanspec/src/scanspec/regions.py:docstring of scanspec.regions.Circle:1: WARNING: py:class reference target not found: annotated_types.Gt [ref.class]

Which is coming from these lines...

https://github.com/bluesky/scanspec/blob/d5cce50b6048bc82b3540d3f64fcb7219e780418/src/scanspec/regions.py#L264C1-L271C6

    x_verts: list[float] = Field(
        description="The Nx1 x coordinates of the polygons vertices", min_length=3
    )
    y_verts: list[float] = Field(
        description="The Nx1 y coordinates of the polygons vertices", min_length=3
    )
@ZohebShaikh
Copy link
Contributor Author

There is a draft branch created at #137

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

1 participant