small doc update

CliMA · Dec 8, 2023 · 725361e · 725361e
1 parent c544abf
commit 725361e
Showing 1 changed file with 2 additions and 2 deletions.
diff --git 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()`