merge main

Merge commit '51e17745f2383f663bc4ff9b6bdba1553af888d2'

#Conflicts:
#	NEWS.md

Author: EmilHvitfeldt

NEWS.md

@@ -2,6 +2,8 @@
 
 * Documentation for tidy methods for all steps has been improved to describe the return value more accurately. (#262)
 
+* 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

@@ -147,8 +147,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

@@ -128,8 +128,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

@@ -236,8 +236,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

@@ -203,8 +203,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

@@ -139,8 +139,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

@@ -161,8 +161,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

@@ -144,8 +144,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

@@ -206,8 +206,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)) {

R/stem.R

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