From 01c9c677f48ad6ebf3230277eefade91720adffc Mon Sep 17 00:00:00 2001
From: Jack Davison <jack.davison@ricardo.com>
Date: Mon, 13 May 2024 10:54:07 +0100
Subject: [PATCH] docs: fix key documentation

---
 R/polar_polarMap.R                  | 2 +-
 man/annulusMap.Rd                   | 2 +-
 man/deprecated-static-polar-maps.Rd | 2 +-
 man/diffMap.Rd                      | 2 +-
 man/freqMap.Rd                      | 2 +-
 man/percentileMap.Rd                | 2 +-
 man/polarMap.Rd                     | 2 +-
 man/pollroseMap.Rd                  | 2 +-
 man/windroseMap.Rd                  | 2 +-
 9 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/R/polar_polarMap.R b/R/polar_polarMap.R
index 19ff0d7..041866a 100644
--- a/R/polar_polarMap.R
+++ b/R/polar_polarMap.R
@@ -169,7 +169,7 @@
 #'
 #'   A value between 0 (fully transparent) and 1 (fully opaque).
 #'
-#' @param key *Transparency value for polar markers.*
+#' @param key *Draw individual marker legends?*
 #'
 #'  *default:* `FALSE` | *scope:* dynamic & static
 #'
diff --git a/man/annulusMap.Rd b/man/annulusMap.Rd
index 958e6cb..9827ac4 100644
--- a/man/annulusMap.Rd
+++ b/man/annulusMap.Rd
@@ -166,7 +166,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/deprecated-static-polar-maps.Rd b/man/deprecated-static-polar-maps.Rd
index 447df6f..a7ba284 100644
--- a/man/deprecated-static-polar-maps.Rd
+++ b/man/deprecated-static-polar-maps.Rd
@@ -263,7 +263,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/diffMap.Rd b/man/diffMap.Rd
index bcac39e..95acdc1 100644
--- a/man/diffMap.Rd
+++ b/man/diffMap.Rd
@@ -158,7 +158,7 @@ recommended to use a "diverging" colour palette (along with a symmetrical
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/freqMap.Rd b/man/freqMap.Rd
index 6582172..f3ef6d2 100644
--- a/man/freqMap.Rd
+++ b/man/freqMap.Rd
@@ -176,7 +176,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/percentileMap.Rd b/man/percentileMap.Rd
index 2d5c953..0be507e 100644
--- a/man/percentileMap.Rd
+++ b/man/percentileMap.Rd
@@ -163,7 +163,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/polarMap.Rd b/man/polarMap.Rd
index 0b1923f..6ea2131 100644
--- a/man/polarMap.Rd
+++ b/man/polarMap.Rd
@@ -179,7 +179,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/pollroseMap.Rd b/man/pollroseMap.Rd
index 6891116..75c29a5 100644
--- a/man/pollroseMap.Rd
+++ b/man/pollroseMap.Rd
@@ -165,7 +165,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static
 
diff --git a/man/windroseMap.Rd b/man/windroseMap.Rd
index 14fda43..6a6c07b 100644
--- a/man/windroseMap.Rd
+++ b/man/windroseMap.Rd
@@ -145,7 +145,7 @@ uniform colours. Read more about this palette at
 
 A value between 0 (fully transparent) and 1 (fully opaque).}
 
-\item{key}{\emph{Transparency value for polar markers.}
+\item{key}{\emph{Draw individual marker legends?}
 
 \emph{default:} \code{FALSE} | \emph{scope:} dynamic & static