From 725361e34c3f5910e1a8e2d287ad16daa49f7f24 Mon Sep 17 00:00:00 2001 From: nefrathenrici Date: Fri, 1 Dec 2023 11:32:11 -0800 Subject: [PATCH] small doc update --- docs/src/name_map.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/name_map.md b/docs/src/name_map.md index 522f7585..4b7b9f01 100644 --- a/docs/src/name_map.md +++ b/docs/src/name_map.md @@ -16,7 +16,7 @@ The constructor checks for bijection, so mappings are guaranteed to be unique. This mapping allows developers to use short custom names when retrieving parameters. The primary way to retrieve parameters is with `get_parameter_values`. -To use this, pass in the `toml_dict` and the short names of the parameters you wish to retrieve. +By default, `get_parameter_values` takes in a `ParamDict` and short names of parameters, finds their corresponding TOML entries from the default parameter name map, and returns a NamedTuple with the short names and their corresponding values: ```julia toml_dict = CP.create_toml_dict(Float64) @@ -29,7 +29,7 @@ params.Omega ``` #### How do I know which short names to use? -Here, no name mapping is explicitly being used. If no name map is provided, the default mapping will be used. +In the example above, no name mapping is explicitly being used. If no name map is provided, the default mapping will be used. The default mapping is made from the parameters names to corresponding former aliases, and can be accessed via `default_param_name_map()`