search

bluesky / scanspec

Specify step and flyscan paths in a serializable, efficient and Pythonic way
Apache License 2.0
8 stars 3 forks source link

Sphinx Docs warning #136

Open ZohebShaikh opened 3 months ago

ZohebShaikh commented 3 months ago

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 commented 3 months ago

There is a draft branch created at https://github.com/bluesky/scanspec/pull/137