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

Notes on docs #56

Closed
maelle opened this issue Sep 18, 2023 · 9 comments
Closed

Notes on docs #56

maelle opened this issue Sep 18, 2023 · 9 comments

Comments

@maelle
Copy link
Collaborator

maelle commented Sep 18, 2023

In https://duckdblabs.github.io/duckplyr/reference/as_duckplyr_df.html

for whatever reason

I know it's due to the experimental aspect but I wonder if a note could be added of what the reason could be.

There could furthermore be a mention of the environment variables DUCKPLYR_FALLBACK_INFO and DUCKPLYR_FORCE at that point.

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

In the README

CAVEAT: factor columns are not supported yet

is there a list of not-supported-yet features that could be added to the docs?

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

Consider putting the "Extensibility" section in a separate vignette rather than in the README.

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

I'd expect the methods to have their own docs page, which might be the occasion to list caveats?

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

In the docs of df_from_file why not add an example using the options argument?

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

In https://duckdblabs.github.io/duckplyr/reference/config.html

DUCKPLYR_OUTPUT_ORDER: If TRUE, row output order is preserved. If FALSE,

the sentence is incomplete.

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

In https://duckdblabs.github.io/duckplyr/reference/config.html

why use rlang for options and withr for environment variables instead of withr for both?

@maelle
Copy link
Collaborator Author

maelle commented Sep 18, 2023

In https://duckdblabs.github.io/duckplyr/reference/stats_show.html

The meaning of each line should be documented.

@krlmlr krlmlr closed this as completed in e49401f Sep 19, 2023
@krlmlr
Copy link
Member

krlmlr commented Sep 19, 2023

Thanks! No list yet, this is a target moving too quickly.

Large-scale rearrangements will have to wait.

rlang::with_options() has the nicer interface.

Copy link
Contributor

This old thread has been automatically locked. If you think you have found something related to this, please open a new issue and link to this old issue if necessary.

@github-actions github-actions bot locked and limited conversation to collaborators Sep 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants