Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Collection of documentation tweaks #6352

Merged
merged 17 commits into from
Aug 2, 2022
Merged

Collection of documentation tweaks #6352

merged 17 commits into from
Aug 2, 2022

Conversation

hadley
Copy link
Member

@hadley hadley commented Jul 21, 2022

Fixes #6017. Fixes #5958. Fixes #6233. Fixes #5943. Fixes #6326. Fixes #6205.

@hadley hadley marked this pull request as ready for review July 22, 2022 16:23
@hadley hadley requested a review from DavisVaughan July 22, 2022 16:24
#' union_all(a, b)
NULL

#' @name setops
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See r-lib/roxygen2#1408 as an approach to hopefully make this easier in the future.

Copy link
Member

@DavisVaughan DavisVaughan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a bunch of small tweaks

Comment on lines +30 to +32
#' - `NULL`: the default, returns the selected columns in a data frame
#' without applying a transformation. This is useful for when you want to
#' use a function that takes a data frame.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add pick(), we should probably slowly deprecate this. So then there aren't two ways to do the same thing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed

Comment on lines -27 to +28
#' it will error, and require you to specify the name.
#' it will use `nn`. If there's a column called `n` and `nn`, it'll use
#' `nnn`, and so on, adding `n`s until it gets a new name.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to mention that it outputs a message in this case?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No 😄 I don't think this behaviour is that important (and I generally regret it as being too clever)

#' @aliases union
#' @usage union(x, y, ...)
#' @importFrom generics union
#' @export union
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screen Shot 2022-08-01 at 4 33 56 PM

Hmm, doing ?intersect and then clicking on the Set operations page for generics doesn't seem to link to the dplyr methods page

This doesn't work with the CRAN version of dplyr either

_pkgdown.yml Outdated
Comment on lines 72 to 74
- across
- c_across
- between
- c_across
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want across() and c_across() mentioned both here and in their special Multiple columns section?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops no

_pkgdown.yml Outdated
- case_when
- coalesce
- cumany
- desc
- if_else
- lead
- order_by
- "n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The context dependent expressions that come from including n() here somehow feel like they dont belong in this "Vector functions" section

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, moved to grouping since that's where they mostly live. Could also consider moving cur_column() into across() or its own file.

@hadley hadley merged commit 2bd4895 into main Aug 2, 2022
@hadley hadley deleted the doc-tweaks branch August 2, 2022 23:01
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
3 participants