Skip to content

Commit 479ffd3

Browse files
committed
Clarify --aliases help text to explain schema field becomes Pydantic alias
1 parent 1d221da commit 479ffd3

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/datamodel_code_generator/arguments.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -816,12 +816,13 @@ def start_section(self, heading: str | None) -> None:
816816
template_options.add_argument(
817817
"--aliases",
818818
help="Alias mapping file (JSON) for renaming fields. "
819+
"Format: {'<schema_field>': '<python_name>'} - the schema field name becomes the Pydantic alias. "
819820
"Supports hierarchical formats: "
820-
"Flat: {'field': 'alias'} applies to all occurrences. "
821-
"Scoped: {'ClassName.field': 'alias'} applies to specific class. "
821+
"Flat: {'id': 'id_'} applies to all occurrences. "
822+
"Scoped: {'User.name': 'user_name'} applies to specific class. "
822823
"Priority: scoped > flat. "
823-
"Multiple aliases (Pydantic v2 only): {'field': ['alias1', 'alias2']} uses AliasChoices for validation. "
824-
"Example: {'User.name': 'user_name', 'id': 'id_', 'field': ['my-field', 'my_field']}",
824+
"Multiple aliases (Pydantic v2 only): {'field': ['alt1', 'alt2']} uses AliasChoices for validation. "
825+
"Example: {'User.name': 'user_name', 'id': 'id_'} generates `id_: ... = Field(alias='id')`.",
825826
type=Path,
826827
)
827828
template_options.add_argument(

0 commit comments

Comments
 (0)