Correct documentation for hue and saturation. Closes #2

jolars · Oct 29, 2018 · b3d6971 · b3d6971
1 parent 0832c6c
commit b3d6971
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,7 @@
 * `qualpal()` gains an argument, `n_threads`, for specifying the number
 of threads to use when computing the distance matrix between colors.
 * C++ functions call namespaces explicitly using `::`.
+* Documentation for hue and saturation in `qualpal()` has been fixed. (#2)
 
 # qualpalr 0.4.2
 

diff --git a/R/qualpal.R b/R/qualpal.R
@@ -40,8 +40,8 @@
 #'     \item{A \code{\link{list}} with the following \emph{named} vectors,
 #'       each of length two, giving a range for each item.}{
 #'       \describe{
-#'         \item{\code{h}}{Hue, in the range [0, 1]}
-#'         \item{\code{s}}{Saturation, in the range [-360, 360]}
+#'         \item{\code{h}}{Hue, in the range [-360, 360]}
+#'         \item{\code{s}}{Saturation, in the range [0, 1]}
 #'         \item{\code{l}}{Lightness, in the range [0, 1]}
 #'       }
 #'     }

diff --git a/man/qualpal.Rd b/man/qualpal.Rd