Skip to content

Commit

Permalink
Geoarrow docstring update (#705)
Browse files Browse the repository at this point in the history
updated docstrings for GeoArrow functions that were moved and removed
references to GeoTable

closes #702
  • Loading branch information
ATL2001 authored Nov 11, 2024
1 parent b3b30ef commit 64fafea
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/ecosystem/geoarrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There's a burgeoning ecosystem of Python libraries that use GeoArrow directly. C
[geoarrow-rust](https://geoarrow.org/geoarrow-rs/python/latest/) is a Python library implementing the GeoArrow specification with efficient spatial operations. This library has "rust" in the name because it is implemented based on the [GeoArrow Rust implementation](https://geoarrow.org/geoarrow-rs/).

```py
from geoarrow.rust.core import GeoTable, read_geojson
from geoarrow.rust.io import read_geojson
from lonboard import Map, PathLayer

path = "/path/to/file.geojson"
Expand Down
10 changes: 5 additions & 5 deletions lonboard/_layer.py
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ class PolygonLayer(BaseArrowLayer):
From [geoarrow-rust](https://geoarrow.github.io/geoarrow-rs/python/latest):
```py
from geoarrow.rust.core import read_parquet
from geoarrow.rust.io import read_parquet
from lonboard import Map, PolygonLayer
# Example: A GeoParquet file with Polygon or MultiPolygon geometries
Expand Down Expand Up @@ -1241,7 +1241,7 @@ class ScatterplotLayer(BaseArrowLayer):
From [geoarrow-rust](https://geoarrow.github.io/geoarrow-rs/python/latest):
```py
from geoarrow.rust.core import read_parquet
from geoarrow.rust.io import read_parquet
from lonboard import Map, ScatterplotLayer
# Example: A GeoParquet file with Point or MultiPoint geometries
Expand Down Expand Up @@ -1482,7 +1482,7 @@ class PathLayer(BaseArrowLayer):
From [geoarrow-rust](https://geoarrow.github.io/geoarrow-rs/python/latest):
```py
from geoarrow.rust.core import read_parquet
from geoarrow.rust.io import read_parquet
from lonboard import Map, PathLayer
# Example: A GeoParquet file with LineString or MultiLineString geometries
Expand Down Expand Up @@ -1787,7 +1787,7 @@ class SolidPolygonLayer(BaseArrowLayer):
From [geoarrow-rust](https://geoarrow.github.io/geoarrow-rs/python/latest):
```py
from geoarrow.rust.core import read_parquet
from geoarrow.rust.io import read_parquet
from lonboard import Map, SolidPolygonLayer
# Example: A GeoParquet file with Polygon or MultiPolygon geometries
Expand Down Expand Up @@ -1953,7 +1953,7 @@ class HeatmapLayer(BaseArrowLayer):
From [geoarrow-rust](https://geoarrow.github.io/geoarrow-rs/python/latest):
```py
from geoarrow.rust.core import read_parquet
from geoarrow.rust.io import read_parquet
from lonboard import Map, HeatmapLayer
# Example: A GeoParquet file with Point geometries
Expand Down
4 changes: 0 additions & 4 deletions lonboard/traits.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,6 @@ class ArrowTableTrait(FixedErrorTraitType):
- A pyarrow [`Table`][pyarrow.Table] or containing a geometry column with [GeoArrow metadata](https://geoarrow.org/extension-types).
- Any GeoArrow table from a library that implements the [Arrow PyCapsule
Interface](https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html).
This includes the
[`GeoTable`](https://geoarrow.github.io/geoarrow-rs/python/latest/api/core/table/#geoarrow.rust.core.GeoTable)
class from
[`geoarrow-rust`](https://geoarrow.github.io/geoarrow-rs/python/latest/).
"""

default_value = None
Expand Down

0 comments on commit 64fafea

Please sign in to comment.