Skip to content

feat: Add documentation and GitHub links to --help output #2682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koxudaxi merged 1 commit into from
Dec 18, 2025
Merged

feat: Add documentation and GitHub links to --help output #2682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/datamodel_code_generator/arguments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import json
import locale
from argparse import ArgumentParser, ArgumentTypeError, BooleanOptionalAction, HelpFormatter, Namespace
from argparse import ArgumentParser, ArgumentTypeError, BooleanOptionalAction, Namespace, RawDescriptionHelpFormatter
from operator import attrgetter
from pathlib import Path
from typing import TYPE_CHECKING, cast
Expand Down Expand Up @@ -62,8 +62,8 @@ def _dataclass_arguments(value: str) -> DataclassArguments:
return cast("DataclassArguments", result)


class SortingHelpFormatter(HelpFormatter):
"""Help formatter that sorts arguments and adds color to section headers."""
class SortingHelpFormatter(RawDescriptionHelpFormatter):
"""Help formatter that sorts arguments, adds color to section headers, and preserves epilog formatting."""

def _bold_cyan(self, text: str) -> str: # noqa: PLR6301
"""Wrap text in ANSI bold cyan escape codes."""
Expand All @@ -81,7 +81,10 @@ def start_section(self, heading: str | None) -> None:

arg_parser = ArgumentParser(
usage="\n datamodel-codegen [options]",
description="Generate Python data models from schema definitions or structured data",
description="Generate Python data models from schema definitions or structured data\n\n"
"For detailed usage, see: https://koxudaxi.github.io/datamodel-code-generator",
epilog="Documentation: https://koxudaxi.github.io/datamodel-code-generator\n"
"GitHub: https://github.com/koxudaxi/datamodel-code-generator",
formatter_class=SortingHelpFormatter,
add_help=False,
)
Expand Down
Loading