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

Copy the contents of docs.R to a vignette #843

Open
eitsupi opened this issue Feb 24, 2024 · 1 comment
Open

Copy the contents of docs.R to a vignette #843

eitsupi opened this issue Feb 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@eitsupi
Copy link
Collaborator

eitsupi commented Feb 24, 2024

I think this document should be a vignette.
https://github.com/pola-rs/r-polars/blob/9a09cb48ef38efbfc05cf25ef371856f49d53d2b/R/docs.R

@eitsupi eitsupi added the documentation Improvements or additions to documentation label Feb 24, 2024
@etiennebacher
Copy link
Collaborator

Oh wow I never came across this file. I'm not sure it should be a vignette, there is a lot of different stuff in there: how R objects are treated in Rust, details on Floats and Ints, on how Python dicts are equivalent to lists, etc. There are also some things that I don't think are interesting enough to be in a vignette, like the analogy with base plot and ggplot2 at the end.

I think we could use some parts of it in additional vignettes. For example, at some point I would like to have a vignette that clearly explains how missing data are handled (like when are they broadcast and when are they ignored?). We could use the two paragraphs about "Missingness" and "Nulls" in the linked file for that.

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

No branches or pull requests

2 participants