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

Feedback tidy eval documentation #1316

Open
brshallo opened this issue Nov 19, 2021 · 1 comment
Open

Feedback tidy eval documentation #1316

brshallo opened this issue Nov 19, 2021 · 1 comment

Comments

@brshallo
Copy link

brshallo commented Nov 19, 2021

Specifically on Data mask programming patterns (#1307 ).

Move Argument Behaviors

Consider moving "Argument behaviours" section to a separate vignette or somewhere else within the "Data Mask Programming Behaviors". I felt like "Choosing a Pattern" sets-up the Forwarding, Name, Bridge patterns and I would have rather just gotten into the examples (i.e. start the "Forwarding" section) rather than having the "Argument behaviors" section come in between them. Or maybe just shorten it in some way... I did like it's description on how to document these in your own functions, I just found it's location (as well as how abstract the section is compared to the more concrete, example filled sections that follow it) added some cognitive load for me while going through the vignette.

Add Transformation Patterns to "Choosing a Pattern" section

You set-up Forwarding, Name, and Bridge Patterns, here:

image

but don't mention Transformation Patterns a wording you use at the end of the vignette.

image

Clarify meaning of "template"

For this section:

For inputs in ... however, this technique does not work. We would need some kind of templating syntax for dots that lets us specify R code with a placeholder for the dots elements. This isn't built in tidy eval but you can use operators like dplyr::across(), dplyr::if_all(), or dplyr::if_any(). When that isn't possible, you can template the expression manually.

Maybe adjust wording or add a hyperlink to an example on what "templating syntax" or "template" means in this context...

Typo

The easiest way it to forward the dots

See typo, "it" should be "is"

@lionel-
Copy link
Member

lionel- commented Nov 25, 2021

Thanks for the feedback. Ideally there'd be an overview article for argument behaviours, but there isn't one yet. At some point the section you mentioned will be turned into its own article. In the meantime, I believe it is necessary to explain argument behaviours before getting into the various patterns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants