Merge pull request #261 from tidymodels/tidy-pkgdown

have ?tidy.step_* point to step_*

Author: EmilHvitfeldt

DESCRIPTION

@@ -62,5 +62,5 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 SystemRequirements: "GNU make"

NEWS.md

@@ -1,5 +1,7 @@
 # textrecipes (development version)
 
+* Calling `?tidy.step_*()` now sends you to the documentation for `step_*()` where the outcome is documented. (#261)
+
 # textrecipes 1.0.6
 
 * textfeatures has been removed from Suggests. (#255)

R/clean_levels.R

@@ -141,8 +141,8 @@ print.step_clean_levels <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_clean_levels` object.
+#' @rdname step_clean_levels
+#' @usage NULL
 #' @export
 tidy.step_clean_levels <- function(x, ...) {
   if (is_trained(x)) {

R/clean_names.R

@@ -122,8 +122,8 @@ print.step_clean_names <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_clean_names` object.
+#' @rdname step_clean_names
+#' @usage NULL
 #' @export
 tidy.step_clean_names <- function(x, ...) {
   if (is_trained(x)) {

R/dummy_hash.R

@@ -230,8 +230,8 @@ print.step_dummy_hash <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_dummy_hash` object.
+#' @rdname step_dummy_hash
+#' @usage NULL
 #' @export
 tidy.step_dummy_hash <- function(x, ...) {
   if (is_trained(x)) {

R/lda.R

@@ -197,8 +197,8 @@ print.step_lda <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_lda` object.
+#' @rdname step_lda
+#' @usage NULL
 #' @export
 tidy.step_lda <- function(x, ...) {
   if (is_trained(x)) {

R/lemma.R

@@ -134,8 +134,8 @@ print.step_lemma <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_lemma` object.
+#' @rdname step_lemma
+#' @usage NULL
 #' @export
 tidy.step_lemma <- function(x, ...) {
   if (is_trained(x)) {

R/ngram.R

@@ -156,8 +156,8 @@ print.step_ngram <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_ngram` object.
+#' @rdname step_ngram
+#' @usage NULL
 #' @export
 tidy.step_ngram <- function(x, ...) {
   if (is_trained(x)) {

R/pos_filter.R

@@ -139,8 +139,8 @@ print.step_pos_filter <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_pos_filter` object.
+#' @rdname step_pos_filter
+#' @usage NULL
 #' @export
 tidy.step_pos_filter <- function(x, ...) {
   if (is_trained(x)) {

R/sequence_onehot.R

@@ -200,8 +200,8 @@ print.step_sequence_onehot <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_sequence_onehot` object.
+#' @rdname step_sequence_onehot
+#' @usage NULL
 #' @export
 tidy.step_sequence_onehot <- function(x, ...) {
   if (is_trained(x)) {