Slightly modify the function documentation details

The intention I had when I wrote `ehpi::epi()` in the Rd is misunderstood by either box::help or by the man page generation of plain text documentation which box::help fetches. This should fix that.
bryce-carson · Jun 28, 2024 · a6e3ad6 · a6e3ad6
1 parent ac2e960
commit a6e3ad6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/epi.R b/R/epi.R
@@ -1,7 +1,7 @@
 #' An interface to eight compartmental epidemic models.
 #'
-#' [ehpi::epi()] is an application programming interface (for the
-#' Shiny application that motivated its creation) or a convenient function for
+#' ehpi is an application programming interface (for the Shiny application that
+#' motivated its creation) or a convenient function [ehpi::epi()] for
 #' interactive use in epidemic modelling. The arguments provided to the function
 #' determine compartments used in the model that is run.
 #'

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