ARROW-15011: [R] Generate documentation for dplyr function bindings #14014
Conversation
|
Current status: check fails with so need to add docs for add_filename and cast and add special casing for str_like since it is not yet released still. Also will need to rebase and add special handling for |
nealrichardson
force-pushed
the
fun-doc
branch
from
962fc85 to
bcf0900
Compare
|
@github-actions crossbow submit -p pr_number=14014 preview-docs |
|
This is ready for review. Feel free to wordsmith the doc page and bike-shed the Rd name (maybe |
|
Revision: 0849160cae0a806b89040fdc152b6c51cd5f0f5f Submitted crossbow builds: ursacomputing/crossbow @ actions-84482a9513
|
nealrichardson
force-pushed
the
fun-doc
branch
from
0849160 to
2ced7b6
Compare
|
Benchmark runs are scheduled for baseline = 2e72e0a and contender = 93626ee. 93626ee is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
…pache#14014) Approach: * `register_binding` takes an additional optional argument, `notes`, where you can list any limitations or differences in behavior between the Arrow version and the R function * These notes are put in the `.cache` environment when the nse_funcs are built. * New script `data-raw/docgen.R` that reads `arrow:::.cache$docs` and writes out `dplyr-funcs-docs.R` containing roxygen. * Similarly, we pull the dplyr functions we s3_register and add them to the generated docs. Unfortunately, the notes about feature limitations aren't easily kept alongside the functions themselves because of how they're registered on load. The approach here creates a list in `arrow-package.R`, where the `.onLoad()` happens, and notes go there. * Docs and crossreferences are generated by roxygen2 as usual. I deferred filling in all of the function notes. See followup JIRAs on ARROW-17665. Authored-by: Neal Richardson <neal.p.richardson@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
3 participants
Approach:
register_bindingtakes an additional optional argument,notes, where you can list any limitations or differences in behavior between the Arrow version and the R function.cacheenvironment when the nse_funcs are built.data-raw/docgen.Rthat readsarrow:::.cache$docsand writes outdplyr-funcs-docs.Rcontaining roxygen.arrow-package.R, where the.onLoad()happens, and notes go there.I deferred filling in all of the function notes. See followup JIRAs on ARROW-17665.