[jira] [Resolved] (ARROW-11849) [R] Use roxygen @examplesIf tag in R docs

["Ian Cook (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/ARROW-11849?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ian Cook resolved ARROW-11849.
------------------------------
    Fix Version/s: 5.0.0
       Resolution: Fixed

Issue resolved by pull request 10373
[https://github.com/apache/arrow/pull/10373]

> [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: Nic Crane
>            Priority: Major
>              Labels: pull-request-available
>             Fix For: 5.0.0
>
>          Time Spent: 2h 40m
>  Remaining Estimate: 0h
>
> 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)