From d527a6e9d705351575caefacc2a15aaeece6c221 Mon Sep 17 00:00:00 2001
From: Teun van den Brand <49372158+teunbrand@users.noreply.github.com>
Date: Mon, 18 Mar 2024 09:00:33 +0100
Subject: [PATCH] Note legend interaction (#5732)

---
 R/scale-.R            | 3 ++-
 man/discrete_scale.Rd | 3 ++-
 man/scale_discrete.Rd | 3 ++-
 man/scale_grey.Rd     | 3 ++-
 man/scale_hue.Rd      | 3 ++-
 man/scale_linetype.Rd | 3 ++-
 man/scale_manual.Rd   | 3 ++-
 man/scale_shape.Rd    | 3 ++-
 8 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/R/scale-.R b/R/scale-.R
index 5ab2f2e364..96472e4f5b 100644
--- a/R/scale-.R
+++ b/R/scale-.R
@@ -188,7 +188,8 @@ continuous_scale <- function(aesthetics, scale_name = deprecated(), palette, nam
 #'     notation.
 #' @param drop Should unused factor levels be omitted from the scale?
 #'    The default, `TRUE`, uses the levels that appear in the data;
-#'    `FALSE` uses all the levels in the factor.
+#'    `FALSE` includes the levels in the factor. Please note that to display
+#'    every level in a legend, the layer should use `show.legend = TRUE`.
 #' @param na.translate Unlike continuous scales, discrete scales can easily show
 #'   missing values, and do so by default. If you want to remove missing values
 #'   from a discrete scale, specify `na.translate = FALSE`.
diff --git a/man/discrete_scale.Rd b/man/discrete_scale.Rd
index 5fad9a9417..0fd213cd30 100644
--- a/man/discrete_scale.Rd
+++ b/man/discrete_scale.Rd
@@ -86,7 +86,8 @@ where \code{NA} is always placed at the far right.}
 
 \item{drop}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
 
 \item{guide}{A function used to create a guide or its name. See
 \code{\link[=guides]{guides()}} for more information.}
diff --git a/man/scale_discrete.Rd b/man/scale_discrete.Rd
index 3955316322..d78db5118b 100644
--- a/man/scale_discrete.Rd
+++ b/man/scale_discrete.Rd
@@ -53,7 +53,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}
diff --git a/man/scale_grey.Rd b/man/scale_grey.Rd
index 2dd9cf724e..f7b96635bd 100644
--- a/man/scale_grey.Rd
+++ b/man/scale_grey.Rd
@@ -56,7 +56,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}
diff --git a/man/scale_hue.Rd b/man/scale_hue.Rd
index 80e9852057..ec8f1862e1 100644
--- a/man/scale_hue.Rd
+++ b/man/scale_hue.Rd
@@ -62,7 +62,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}
diff --git a/man/scale_linetype.Rd b/man/scale_linetype.Rd
index 49b7e10bb4..e30fa419e3 100644
--- a/man/scale_linetype.Rd
+++ b/man/scale_linetype.Rd
@@ -47,7 +47,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}
diff --git a/man/scale_manual.Rd b/man/scale_manual.Rd
index 6f8234a051..4453a5e1ec 100644
--- a/man/scale_manual.Rd
+++ b/man/scale_manual.Rd
@@ -58,7 +58,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}
diff --git a/man/scale_shape.Rd b/man/scale_shape.Rd
index 2e1ce1512e..4edd263c4f 100644
--- a/man/scale_shape.Rd
+++ b/man/scale_shape.Rd
@@ -44,7 +44,8 @@ notation.
 }}
     \item{\code{drop}}{Should unused factor levels be omitted from the scale?
 The default, \code{TRUE}, uses the levels that appear in the data;
-\code{FALSE} uses all the levels in the factor.}
+\code{FALSE} includes the levels in the factor. Please note that to display
+every level in a legend, the layer should use \code{show.legend = TRUE}.}
     \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show
 missing values, and do so by default. If you want to remove missing values
 from a discrete scale, specify \code{na.translate = FALSE}.}