Skip to content

Commit 10b5814

Browse files
Update documentation.
1 parent 63c373c commit 10b5814

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

docs/get_started.qmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Above, we saved the data as a CSV, but you can choose another option depending o
7575
- `type = "arrow"` uses `to_feather()` from pandas to create an Arrow/Feather file.
7676
- `type = "joblib"` uses `joblib.dump()` to create a binary Python data file, such as for storing a trained model. See the [joblib docs](https://joblib.readthedocs.io/en/latest/) for more information.
7777
- `type = "json"` uses `json.dump()` to create a JSON file. Pretty much every programming language can read JSON files, but they only work well for nested lists.
78+
- `type = "geoparquet"` uses `to_parquet()` from [geopandas](https://github.com/geopandas/geopandas) to create a [GeoParquet](https://github.com/opengeospatial/geoparquet) file, which is a specialized Parquet format for geospatial data.
7879

7980
Note that when the data lives elsewhere, pins takes care of downloading and caching so that it's only re-downloaded when needed.
8081
That said, most boards transmit pins over HTTP, and this is going to be slow and possibly unreliable for very large pins.

pins/boards.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ def pin_write(
335335
Pin name.
336336
type:
337337
File type used to save `x` to disk. May be "csv", "arrow", "parquet",
338-
"joblib", or "json".
338+
"joblib", "json", or "geoparquet".
339339
title:
340340
A title for the pin; most important for shared boards so that others
341341
can understand what the pin contains. If omitted, a brief description

0 commit comments

Comments
 (0)