Minor docs fixes

brentyi · Sep 21, 2022 · 11930b5 · 11930b5
1 parent 3df0e54
commit 11930b5
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/source/examples/04_flags.rst b/docs/source/examples/04_flags.rst
@@ -8,7 +8,7 @@
 Booleans can either be expected to be explicitly passed in, or, if given a default
 value, automatically converted to flags.
 
-To turn off conversion, see :func:`dcargs.conf.FlagConversionOff`.
+To turn off conversion, see :class:`dcargs.conf.FlagConversionOff`.
 
 
 

diff --git a/docs/source/examples/05_hierarchical_configs.rst b/docs/source/examples/05_hierarchical_configs.rst
@@ -41,7 +41,7 @@ objects. This helps with modularity and grouping in larger projects.
         @dataclasses.dataclass
         class ExperimentConfig:
             # Various configurable options for our optimizer.
-            optimizer_config: OptimizerConfig
+            optimizer: OptimizerConfig
 
             # Batch size.
             batch_size: int = 32

diff --git a/examples/04_flags.py b/examples/04_flags.py
@@ -1,7 +1,7 @@
 """Booleans can either be expected to be explicitly passed in, or, if given a default
 value, automatically converted to flags.
 
-To turn off conversion, see :func:`dcargs.conf.FlagConversionOff`.
+To turn off conversion, see :class:`dcargs.conf.FlagConversionOff`.
 
 Usage:
 `python ./04_flags.py --help`

diff --git a/examples/05_hierarchical_configs.py b/examples/05_hierarchical_configs.py
@@ -34,7 +34,7 @@ class OptimizerConfig:
 @dataclasses.dataclass
 class ExperimentConfig:
     # Various configurable options for our optimizer.
-    optimizer_config: OptimizerConfig
+    optimizer: OptimizerConfig
 
     # Batch size.
     batch_size: int = 32