You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Ian Cook (Jira)" <ji...@apache.org> on 2021/03/03 03:40:00 UTC
[jira] [Created] (ARROW-11849) [R] Use roxygen @examplesIf tag in R
docs
Ian Cook created ARROW-11849:
--------------------------------
Summary: [R] Use roxygen @examplesIf tag in R docs
Key: ARROW-11849
URL: https://issues.apache.org/jira/browse/ARROW-11849
Project: Apache Arrow
Issue Type: Improvement
Components: R
Affects Versions: 3.0.0
Reporter: Ian Cook
Assignee: Ian Cook
The development version of roxygen2 supports a new tag {{@examplesIf}} to include examples conditionally: [https://github.com/r-lib/roxygen2/commit/513c9e25262e67e7d3383a0feb51be0ba9b6e21f]
After a version of roxygen2 with this new tag makes its way to CRAN, use it to remove the feature availability conditionals that are used in some examples, including:
* {{if (arrow_available()) \{...}}}
* {{if (arrow_with_dataset()) \{...}}}
* {{if (arrow_with_parquet()) \{...}}}
* {{if (arrow_with_s3()) \{...}}}
This will simplify the examples and avoid giving the misleading suggestion that users need to perform these checks this every time.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)