From 05bb52b5f40374d45419812340115d2f4bab7dd6 Mon Sep 17 00:00:00 2001
From: Julia Silge <julia.silge@gmail.com>
Date: Thu, 17 Feb 2022 17:52:18 -0700
Subject: [PATCH] Add links between `logistic_reg()` and `multinom_reg()`

---
 R/logistic_reg.R    | 3 +++
 R/multinom_reg.R    | 3 +++
 man/logistic_reg.Rd | 3 +++
 man/multinom_reg.Rd | 3 +++
 4 files changed, 12 insertions(+)

diff --git a/R/logistic_reg.R b/R/logistic_reg.R
index 524b50e76..34cf0ed58 100644
--- a/R/logistic_reg.R
+++ b/R/logistic_reg.R
@@ -28,6 +28,9 @@
 #'
 #' @template spec-details
 #'
+#' @details This model fits a classification model for binary outcomes; for
+#' multiclass outcomes, see [multinom_reg()].
+#'
 #' @template spec-references
 #'
 #' @seealso \Sexpr[stage=render,results=rd]{parsnip:::make_seealso_list("logistic_reg")}
diff --git a/R/multinom_reg.R b/R/multinom_reg.R
index aa8058627..2ef6bdaeb 100644
--- a/R/multinom_reg.R
+++ b/R/multinom_reg.R
@@ -28,6 +28,9 @@
 #'
 #' @template spec-details
 #'
+#' @details This model fits a classification model for multiclass outcomes; for
+#' binary outcomes, see [logistic_reg()].
+#'
 #' @template spec-references
 #'
 #' @seealso \Sexpr[stage=render,results=rd]{parsnip:::make_seealso_list("multinom_reg")}
diff --git a/man/logistic_reg.Rd b/man/logistic_reg.Rd
index 582815cc2..f70a1a9fb 100644
--- a/man/logistic_reg.Rd
+++ b/man/logistic_reg.Rd
@@ -47,6 +47,9 @@ is specified, the \emph{method} to fit the model is also defined.
 
 The model is not trained or fit until the \code{\link[=fit.model_spec]{fit.model_spec()}} function is used
 with the data.
+
+This model fits a classification model for binary outcomes; for
+multiclass outcomes, see \code{\link[=multinom_reg]{multinom_reg()}}.
 }
 \examples{
 show_engines("logistic_reg")
diff --git a/man/multinom_reg.Rd b/man/multinom_reg.Rd
index 7a43e39ce..5ad4d7d4e 100644
--- a/man/multinom_reg.Rd
+++ b/man/multinom_reg.Rd
@@ -46,6 +46,9 @@ is specified, the \emph{method} to fit the model is also defined.
 
 The model is not trained or fit until the \code{\link[=fit.model_spec]{fit.model_spec()}} function is used
 with the data.
+
+This model fits a classification model for multiclass outcomes; for
+binary outcomes, see \code{\link[=logistic_reg]{logistic_reg()}}.
 }
 \examples{
 show_engines("multinom_reg")