Skip to content

Commit 32b81ea

Browse files
committed
add doc links
1 parent 064b2c8 commit 32b81ea

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/Parsing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This tutorial explains how to create configs and other objects from source data.
55
- [Parse from yaml](#parse-from-yaml)
66
- [Parse from ROS](#parse-from-ros)
77
- [Parse from the command line](#parse-from-the-command-line)
8+
- [Parse via global context](#parse-via-global-context)
89

910
## Parse from yaml
1011

@@ -127,7 +128,7 @@ int main(int argc, char** argv) {
127128
}
128129
```
129130

130-
# Parsing via global context
131+
# Parse via global context
131132

132133
Usually the command line arguments or parsed YAML are not globally available to every part of an executable.
133134
Similar to the ROS1 parameter server (and access to the parameter server by `ros::NodeHandle`), we provide a global `config::internal::Context` object (included via `parsing/context.h`) that handles tracking parsed YAML.

docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ The following tutorials will guide you through functionalities of `config_utilit
1414
3. [**Parsing configs from data sources**](Parsing.md)
1515
- [Parse from yaml](Parsing.md#parse-from-yaml)
1616
- [Parse from ROS](Parsing.md#parse-from-ros)
17-
- [Parse from command line](Parsing.md#parse-from-command-line)
17+
- [Parse from the command line](Parsing.md#parse-from-the-command-line)
18+
- [Parse via global context](Parsing.md#parse-via-global-context)
1819

1920
4. [**Handling complex configs or types**](Types.md)
2021
- [Sub-configs](Types.md#sub-configs)

0 commit comments

Comments
 (0)