Add documentation topic for tidyselect arguments #365
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DavisVaughan
approved these changes
Oct 25, 2024
R/doc-tidy-selection.R
Outdated
| #' dialect of R for selecting variables based on their names or properties. | ||
| #' | ||
| #' Tidy selection is a variant of tidy evaluation. This means that inside | ||
| #' functions, tidy-select arguments require special attention, as described in |
There was a problem hiding this comment.
Suggested change
| #' functions, tidy-select arguments require special attention, as described in | |
| #' functions that you create, tidy-select arguments require special attention, as described in |
Right? Even though we got to this page from, say, dplyr::select()'s documentation of the ..., you are talking about the case where the reader of the documentation makes their own wrapper function, right? So we should just be super clear about that - because you can also come to this page when you're just like "what's tidyselect?" and you aren't interested in these advanced ideas.
Maybe this whole paragraph should move down into # Details or # Wrapping tidyselect arguments, with ## Indirection as a subheader?
That would let you provide the main details up top (i.e. what is tidyselect) and then later on talk about the complex stuff
lionel-
force-pushed
the
feature/doc-tidyselect
branch
from
99cc41f
to
d0fece8
Compare
Co-authored-by: Davis Vaughan <[email protected]>
Co-authored-by: Davis Vaughan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #328.
I've also updated
overview.Rmdfrom https://github.com/tidyverse/dplyr/blob/e4e9a295a373b85e02ae084a23f12e9212a72b98/man/rmd/overview.Rmd. But I had to remove the reference togroup_cols()which is specific to dplyr.