From 11930b5f65bec5bbc9ee0ceb23fcee1d3cdf1f56 Mon Sep 17 00:00:00 2001 From: Brent Yi Date: Wed, 21 Sep 2022 01:31:06 -0700 Subject: [PATCH] Minor docs fixes --- docs/source/examples/04_flags.rst | 2 +- docs/source/examples/05_hierarchical_configs.rst | 2 +- examples/04_flags.py | 2 +- examples/05_hierarchical_configs.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/examples/04_flags.rst b/docs/source/examples/04_flags.rst index a7741187..30c21788 100644 --- 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 index 253ac14b..f05df0c1 100644 --- 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 index 635acea2..3df1d0c7 100644 --- 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 index 4f696c36..c0a1be98 100644 --- 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