Skip to content

Commit

Permalink
Change: Improve help for update-header arguments
Browse files Browse the repository at this point in the history
Improved usage and print also the defaults.
  • Loading branch information
bjoernricks committed Feb 26, 2024
1 parent a503ff2 commit 74ea568
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions pontos/updateheader/_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ def parse_args(args: Optional[Sequence[str]] = None) -> Namespace:
default=False,
help=(
"Update modified year using git log modified year. "
"This will not changed all files to current year!"
"Used instead of --year. If the modified year could not be "
"determined via git it falls back to --year."
),
)
date_group.add_argument(
Expand All @@ -56,7 +57,7 @@ def parse_args(args: Optional[Sequence[str]] = None) -> Namespace:
default=str(datetime.now().year),
help=(
"If year is set, modified year will be "
"set to the specified year."
"set to the specified year. Default is %(default)s."
),
)

Expand All @@ -66,15 +67,15 @@ def parse_args(args: Optional[Sequence[str]] = None) -> Namespace:
dest="license_id",
choices=SUPPORTED_LICENSES,
default="GPL-3.0-or-later",
help=("Use the passed license type"),
help="Use the passed license type. Default is %(default)s",
)

parser.add_argument(
"--company",
default="Greenbone AG",
help=(
"If a header will be added to file, "
"it will be licensed by company."
"it will be licensed by company. Default is %(default)s"
),
)

Expand Down

0 comments on commit 74ea568

Please sign in to comment.