Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sink_ndjson() doesn't appear in docs #13533

Closed
etiennebacher opened this issue Jan 8, 2024 · 2 comments · Fixed by #13627
Closed

sink_ndjson() doesn't appear in docs #13533

etiennebacher opened this issue Jan 8, 2024 · 2 comments · Fixed by #13627
Labels
documentation Improvements or additions to documentation

Comments

@etiennebacher
Copy link
Contributor

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 etiennebacher added the documentation Improvements or additions to documentation label Jan 8, 2024
@cmdlineluser
Copy link
Contributor

I think it just needs to be added here:

read_json
read_ndjson
scan_ndjson
DataFrame.write_json

@etiennebacher
Copy link
Contributor Author

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?

>>> lf = pl.scan_csv("/path/to/my_larger_than_ram_file.csv") # doctest: +SKIP
>>> lf.sink_json("out.json") # doctest: +SKIP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants