From ae4b5e4796b5e643b719dc0dc699804e074c3afe Mon Sep 17 00:00:00 2001 From: kenomersmannPC Date: Wed, 2 Oct 2024 13:26:28 +0200 Subject: [PATCH] run document --- man/dictionary_sugar_get.Rd | 9 ++++++--- man/dictionary_sugar_inc_get.Rd | 8 ++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/man/dictionary_sugar_get.Rd b/man/dictionary_sugar_get.Rd index f9e77c90..4625c591 100644 --- a/man/dictionary_sugar_get.Rd +++ b/man/dictionary_sugar_get.Rd @@ -6,11 +6,11 @@ \alias{dictionary_sugar_mget} \title{A Quick Way to Initialize Objects from Dictionaries} \usage{ -dictionary_sugar_get(dict, .key, ...) +dictionary_sugar_get(dict, .key, ..., .dicts_suggest = NULL) -dictionary_sugar(dict, .key, ...) +dictionary_sugar(dict, .key, ..., .dicts_suggest = NULL) -dictionary_sugar_mget(dict, .keys, ...) +dictionary_sugar_mget(dict, .keys, ..., .dicts_suggest = NULL) } \arguments{ \item{dict}{(\link{Dictionary}).} @@ -21,6 +21,9 @@ Key of the object to construct.} \item{...}{(\code{any})\cr See description.} +\item{.dicts_suggest}{(named \code{\link{list}}) +Named list of \link[=Dictionary]{dictionaries} used to look up suggestions for \code{.key} in cases of misspelling.} + \item{.keys}{(\code{character()})\cr Keys of the objects to construct.} } diff --git a/man/dictionary_sugar_inc_get.Rd b/man/dictionary_sugar_inc_get.Rd index ca6d3887..0b318527 100644 --- a/man/dictionary_sugar_inc_get.Rd +++ b/man/dictionary_sugar_inc_get.Rd @@ -5,9 +5,9 @@ \alias{dictionary_sugar_inc_mget} \title{A Quick Way to Initialize Objects from Dictionaries with Incremented ID} \usage{ -dictionary_sugar_inc_get(dict, .key, ...) +dictionary_sugar_inc_get(dict, .key, ..., .dicts_suggest = NULL) -dictionary_sugar_inc_mget(dict, .keys, ...) +dictionary_sugar_inc_mget(dict, .keys, ..., .dicts_suggest = NULL) } \arguments{ \item{dict}{(\link{Dictionary})\cr @@ -26,10 +26,10 @@ Keys of the objects to construct - possibly with suffixes of the form \verb{_ An element from the dictionary. } \description{ -Covenience wrapper around \link{dictionary_sugar_get} and \link{dictionary_sugar_mget} to allow easier avoidance of of ID +Covenience wrapper around \link{dictionary_sugar_get} and \link{dictionary_sugar_mget} to allow easier avoidance of ID clashes which is useful when the same object is used multiple times and the ids have to be unique. Let \verb{} be the key of the object to retrieve. When passing the \verb{_} to this -function, where \verb{} is any natural numer, the object with key \verb{} is retrieved and the +function, where \verb{} is any natural number, the object with key \verb{} is retrieved and the suffix \verb{_} is appended to the id after the object is constructed. } \examples{