Skip to content

Commit

Permalink
pydantic description and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
kmagusiak committed Nov 26, 2023
1 parent d898112 commit 7858049
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Finally, the configuration is fully resolved and logging is configured.

## Configuration templates and resolvers

[OmegaConf]'s resolvers may be used as configuration values.
Configuration values are resolved by [OmegaConf].
For example, `${oc.env:USER,me}` would resolve to the environment variable
USER with a default value "me".
Similarly, `${oc.select:path}` will resolve to another configuration value.
Expand All @@ -96,13 +96,13 @@ dict defined in base.logging.default and you can select it using
## Configuration values and integrations

### Typed-configuration
-- TODO update to pydantic

You can use *omegaconf* with *dataclasses* to specify which values are
You can use [OmegaConf] with [pydantic] to specify which values are
enforced in the configuration.
Alternatively, the *get* method can receive a data type or a function
which will parse the value.
By default, bool, str, Path, DateTime, etc. are supported.
TODO describe more, use pydantic to build factories

### Secrets

Expand Down

0 comments on commit 7858049

Please sign in to comment.