[docs] Clarify that describe_distribution() returns excess kurtosis (#662)

* Initial plan

* Clarify that kurtosis is excess kurtosis in describe_distribution docs

Co-authored-by: DominiqueMakowski <[email protected]>

* update rd

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: DominiqueMakowski <[email protected]>
Co-authored-by: Daniel <[email protected]>

Author: 3 people

DESCRIPTION

@@ -76,7 +76,7 @@ VignetteBuilder:
 Encoding: UTF-8
 Language: en-US
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Config/Needs/website: easystats/easystatstemplate

R/describe_distribution.R

@@ -1,7 +1,7 @@
 #' Describe a distribution
 #'
 #' This function describes a distribution by a set of indices (e.g., measures of
-#' centrality, dispersion, range, skewness, kurtosis).
+#' centrality, dispersion, range, skewness, (excess) kurtosis).
 #'
 #' @param x A numeric vector, a character vector, a data frame, or a list. See
 #' `Details`.
@@ -41,6 +41,8 @@
 #'   [`plot()`-method](https://easystats.github.io/see/articles/parameters.html)
 #'   implemented in the [**see**-package](https://easystats.github.io/see/).
 #'
+#' @seealso [kurtosis()] to compute kurtosis (recognized as excess kurtosis).
+#'
 #' @return A data frame with columns that describe the properties of the variables.
 #'
 #' @examplesIf require("bayestestR", quietly = TRUE)