Use dev roxygen2 + doc listing

DESCRIPTION

@@ -23,6 +23,7 @@ Depends:
     R (>= 4.1.0)
 Imports:
     cli (>= 3.6.2),
+    doclisting (>= 0.0.0.9000),
     generics,
     glue (>= 1.3.2),
     lifecycle (>= 1.0.5),
@@ -60,4 +61,6 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.3
+RoxygenNote: 7.3.3.9000
+Remotes:  
+    r-lib/doclisting

R/arrange.R

@@ -24,12 +24,11 @@
 #' * Groups are not modified.
 #' * Data frame attributes are preserved.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("arrange")}.
+#' `Rd doclisting::methods_list("arrange")`
 #' @export
 #' @param .data A data frame, data frame extension (e.g. a tibble), or a
 #'   lazy data frame (e.g. from dbplyr or dtplyr). See *Methods*, below, for

R/compat-dbplyr.R

@@ -56,7 +56,12 @@ wrap_dbplyr_obj <- function(obj_name) {
 }
 utils::globalVariables("!<-")
 
-#' @inherit dbplyr::sql
+#' Literal SQL escaping
+#'
+#' Use `sql()` to declare that a string is literal SQL and should be used
+#' as is, without quoting.
+#'
+#' @param ... Character vectors that will be combined into a single SQL vector.
 #' @export
 sql <- function(...) {
   check_dbplyr()

R/compute-collect.R

@@ -10,14 +10,13 @@
 #' All functions preserve grouping and ordering.
 #'
 #' @section Methods:
-#' These functions are **generics**, which means that packages can provide
+#' These are S3 generics, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
-#' Methods available in currently loaded packages:
-#' * `compute()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("compute")}
-#' * `collect()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("collect")}
-#' * `collapse()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("collapse")}
+#' The following methods are currently available in loaded packages:
+#' * `compute()`: `Rd doclisting::methods_list("compute")`
+#' * `collect()`: `Rd doclisting::methods_list("collect")`
+#' * `collapse()`: `Rd doclisting::methods_list("collapse")`
 #'
 #' @param x A data frame, data frame extension (e.g. a tibble), or a lazy
 #'   data frame (e.g. from dbplyr or dtplyr). See *Methods*, below, for more

R/copy-to.R

@@ -5,12 +5,11 @@
 #' temporary, limited to the current connection to the source.
 #'
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("copy_to")}.
+#' `Rd doclisting::methods_list("copy_to")`
 #' @param dest remote data source
 #' @param df local data frame
 #' @param name name for new remote table.

R/distinct.R

@@ -21,12 +21,11 @@
 #' * Groups are not modified.
 #' * Data frame attributes are preserved.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("distinct")}.
+#' `Rd doclisting::methods_list("distinct")`
 #' @export
 #' @examples
 #' df <- tibble(

R/dplyr.R

@@ -14,6 +14,10 @@
 #' @importFrom R6 R6Class
 "_PACKAGE"
 
+ignore_unused_imports <- function() {
+  doclisting::methods_list
+}
+
 # We're importing vctrs without `data_frame()` because we currently
 # reexport the deprecated `tibble::data_frame()` function
 

R/filter.R

@@ -141,12 +141,11 @@
 #'
 #' @section Methods:
 #'
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("filter")}.
+#' `Rd doclisting::methods_list("filter")`
 #'
 #' @family single table verbs
 #' @name filter

R/group-by.R

@@ -23,14 +23,13 @@
 #'   unless the combination of `...` and `add` yields a empty set of
 #'   grouping columns, in which case a tibble will be returned.
 #' @section Methods:
-#' These function are **generic**s, which means that packages can provide
+#' These are S3 generics, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
+#' The following methods are currently available in loaded packages:
 #'
-#' Methods available in currently loaded packages:
-#'
-#' * `group_by()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("group_by")}.
-#' * `ungroup()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("ungroup")}.
+#' * `group_by()`: `Rd doclisting::methods_list("group_by")`
+#' * `ungroup()`: `Rd doclisting::methods_list("ungroup")`
 #'
 #' @section Ordering:
 #' Currently, `group_by()` internally orders the groups in ascending order. This

R/join-cross.R

@@ -23,12 +23,11 @@
 #' - The order of the rows and columns of `x` is preserved as much as possible.
 #'
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("cross_join")}.
+#' `Rd doclisting::methods_list("cross_join")`
 #'
 #' @family joins
 #' @export

R/join.R

@@ -80,16 +80,15 @@
 #' * If `keep = FALSE`, output columns included in `by` are coerced to their
 #'   common type between `x` and `y`.
 #' @section Methods:
-#' These functions are **generic**s, which means that packages can provide
+#' These are S3 generics, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
+#' The following methods are currently available in loaded packages:
 #'
-#' Methods available in currently loaded packages:
-#'
-#' * `inner_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("inner_join")}.
-#' * `left_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("left_join")}.
-#' * `right_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("right_join")}.
-#' * `full_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("full_join")}.
+#' * `inner_join()`: `Rd doclisting::methods_list("inner_join")`
+#' * `left_join()`: `Rd doclisting::methods_list("left_join")`
+#' * `right_join()`: `Rd doclisting::methods_list("right_join")`
+#' * `full_join()`: `Rd doclisting::methods_list("full_join")`
 #' @param x,y A pair of data frames, data frame extensions (e.g. a tibble), or
 #'   lazy data frames (e.g. from dbplyr or dtplyr). See *Methods*, below, for
 #'   more details.
@@ -451,14 +450,13 @@ full_join.data.frame <- function(
 #' * Data frame attributes are preserved.
 #' * Groups are taken from `x`. The number of groups may be reduced.
 #' @section Methods:
-#' These function are **generic**s, which means that packages can provide
+#' These are S3 generics, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
+#' The following methods are currently available in loaded packages:
 #'
-#' Methods available in currently loaded packages:
-#'
-#' * `semi_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("semi_join")}.
-#' * `anti_join()`: \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("anti_join")}.
+#' * `semi_join()`: `Rd doclisting::methods_list("semi_join")`
+#' * `anti_join()`: `Rd doclisting::methods_list("anti_join")`
 #' @family joins
 #' @examples
 #' # "Filtering" joins keep cases from the LHS
@@ -558,12 +556,11 @@ anti_join.data.frame <- function(
 #' * Gains one new column called `{name}` on the far right, a list column
 #'   containing data frames the same type as `y`.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("nest_join")}.
+#' `Rd doclisting::methods_list("nest_join")`
 #' @inheritParams left_join
 #' @family joins
 #' @export

R/mutate.R

@@ -71,12 +71,11 @@
 #' * Groups will be recomputed if a grouping variable is mutated.
 #' * Data frame attributes are preserved.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
-#' Methods available in currently loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("mutate")}.
+#' The following methods are currently available in loaded packages:
+#' `Rd doclisting::methods_list("mutate")`
 #' @examples
 #' # Newly created variables are available immediately
 #' starwars |>

R/nest-by.R

@@ -42,12 +42,11 @@
 #' * Data frame attributes are **not** preserved, because `nest_by()`
 #'   fundamentally creates a new data frame.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("nest_by")}.
+#' `Rd doclisting::methods_list("nest_by")`
 #'
 #' @inheritParams group_by
 #' @param .key Name of the list column

R/pull.R

@@ -11,12 +11,11 @@
 #' @param ... For use by methods.
 #' @return A vector the same size as `.data`.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("pull")}.
+#' `Rd doclisting::methods_list("pull")`
 #' @export
 #' @examples
 #' mtcars |> pull(-1)

R/reframe.R

@@ -50,12 +50,11 @@
 #' * `reframe()`: data frame -> data frame
 #'
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("reframe")}.
+#' `Rd doclisting::methods_list("reframe")`
 #'
 #' @family single table verbs
 #' @export

R/relocate.R

@@ -18,12 +18,11 @@
 #' * Data frame attributes are preserved.
 #' * Groups are not affected.
 #' @section Methods:
-#' This function is a **generic**, which means that packages can provide
+#' This is an S3 generic, which means that packages can provide
 #' implementations (methods) for other classes. See the documentation of
 #' individual methods for extra arguments and differences in behaviour.
-#'
 #' The following methods are currently available in loaded packages:
-#' \Sexpr[stage=render,results=rd]{dplyr:::methods_rd("relocate")}.
+#' `Rd doclisting::methods_list("relocate")`
 #' @export
 #' @examples
 #' df <- tibble(a = 1, b = 1, c = 1, d = "a", e = "a", f = "a")