Skip to content

Commit

Permalink
Cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
kschwab committed Jul 12, 2024
1 parent e0937cc commit 2f91feb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ annotations can only be applied to required fields (i.e. fields that do not have
subcommands must be a valid type derived from either a pydantic `BaseModel` or pydantic.dataclasses `dataclass`.

Parsed subcommands can be retrieved from model instances using the `get_subcommand` function. If a subcommand is
required, use the `is_required` flag to raise a `SettingsError` if no subcommand is found.
required, use the `is_required` flag to raise an error if no subcommand is found.

!!! note
CLI settings subcommands are limited to a single subparser per model. In other words, all subcommands for a model
Expand Down

0 comments on commit 2f91feb

Please sign in to comment.