Skip to content

Commit 2911b07

Browse files
Update docs.
1 parent 3823804 commit 2911b07

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ board.pin_write(mtcars.head(), "mtcars", type="csv")
6767

6868
Above, we saved the data as a CSV, but depending on what you’re saving
6969
and who else you want to read it, you might use the `type` argument to
70-
instead save it as a `joblib`, `parquet`, or `json` file.
70+
instead save it as a `joblib`, `parquet`, or `json` file. If you're using
71+
a `polars.DataFrame`, you can save to `parquet`.
7172

72-
You can later retrieve the pinned data with `.pin_read()`:
73+
You can later retrieve the pinned data as a `pandas.DataFrame` with `.pin_read()`:
7374

7475
``` python
7576
board.pin_read("mtcars")

README.qmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ board.pin_write(mtcars.head(), "mtcars", type="csv")
6666
Above, we saved the data as a CSV, but depending on
6767
what you’re saving and who else you want to read it, you might use the
6868
`type` argument to instead save it as a `joblib`, `parquet`, or `json` file.
69+
If you're using a `polars.DataFrame`, you can save to `parquet`.
6970

70-
You can later retrieve the pinned data with `.pin_read()`:
71+
You can later retrieve the pinned data as a `pandas.DataFrame` with `.pin_read()`:
7172

7273
```{python}
7374
board.pin_read("mtcars")

0 commit comments

Comments
 (0)