polars icon indicating copy to clipboard operation
polars copied to clipboard

`sink_ndjson()` doesn't appear in docs

Open etiennebacher opened this issue 2 years ago • 2 comments

Description

sink_ndjson() doesn't appear on the docs website, but it was implemented a few weeks ago in #10786.

image

Link

https://docs.pola.rs/docs/python/dev/search.html?q=ndjson

etiennebacher avatar Jan 08 '24 12:01 etiennebacher

I think it just needs to be added here:

https://github.com/pola-rs/polars/blob/67507fffbff54679a4ff0e11f602b41e3ad6b99f/py-polars/docs/source/reference/io.rst?plain=1#L55-L58

cmdlineluser avatar Jan 08 '24 12:01 cmdlineluser

In addition to this, the function on the Python side is called sink_ndjson() but it is called sink_json() on the Rust side. Also, the example is wrong because it calls .sink_json(). Is this distinction between ndjson and json on purpose?

https://github.com/pola-rs/polars/blob/67507fffbff54679a4ff0e11f602b41e3ad6b99f/py-polars/polars/lazyframe/frame.py#L2227-L2228

etiennebacher avatar Jan 08 '24 13:01 etiennebacher