docs: add missing param docstring

ilyaZar · Jun 10, 2023 · 1b4b9ab · 1b4b9ab
1 parent ef69d3f
commit 1b4b9ab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/R/00_generate_simulation_meta_yaml.R b/R/00_generate_simulation_meta_yaml.R
@@ -3,6 +3,9 @@
 #' @inheritParams new_dataSim
 #' @inheritParams set_new_project_name
 #' @param pth_project path to top-level project directory
+#' @param model_type concatenated from [get_type_obs()], [get_type_lat()]:
+#'    `c(model_type_obs = get_type_obs(dataSim),
+#'       model_type_lat = get_type_lat(dataSim))`
 #'
 #' @return side effect function that writes a 'yaml'-config file to path
 #' @export