Apply suggestions from code review

Co-authored-by: James Azam <james.azam@lshtm.ac.uk>
epiforecasts · Sep 20, 2024 · 46793c0 · 46793c0
1 parent 20451cc
commit 46793c0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -26,7 +26,7 @@
 
 ## Package changes
 
-- `fix_dist()` has been renamed to `fix_parameters()`. By @sbfnk in #733 and reviewed by @jamesmbaazam.
+- `fix_dist()` has been renamed to `fix_parameters()` because it removes the uncertainty in a distribution's parameters. By @sbfnk in #733 and reviewed by @jamesmbaazam.
 
 ## Bug fixes
 

diff --git a/R/deprecated.R b/R/deprecated.R
@@ -624,10 +624,10 @@ apply_tolerance <- function(x, tolerance) {
   return(y)
 }
 
-#' Fix the parameters of a `<dist_spec>`
+#' Remove uncertainty in the parameters of a `<dist_spec>`
 #'
 #' @description `r lifecycle::badge("deprecated")`
-#' This function has been renamed to [fix_parameters()].
+#' This function has been renamed to [fix_parameters()] as the former was a misnomer.
 #' @return A `<dist_spec>` object without uncertainty
 #' @keywords internal
 #' @importFrom cli cli_abort