tidyverse/duckplyr

Notes on docs

Closed this issue ยท 9 comments

maelle commented

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 commented

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 commented

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

maelle commented

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

maelle commented

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

maelle commented

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 commented

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 commented

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

The meaning of each line should be documented.

krlmlr commented

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.

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.