Skip to content

Commit ba12313

Browse files
akbakb
authored andcommitted
Allow alias to have help=
1 parent b8af9d3 commit ba12313

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/mario/aliasing.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ def make(self, validated, partial, many):
101101
@attr.dataclass
102102
class Alias:
103103
name: str
104-
short_help: str
104+
short_help: t.Optional[str]
105+
help: t.Optional[str]
105106
arguments: t.List[click.Argument]
106107
options: t.List[click.Option]
107108
stages: t.List[AliasStage]
@@ -110,7 +111,8 @@ class Alias:
110111

111112
class AliasSchema(marshmallow.Schema):
112113
name = fields.String()
113-
short_help = fields.String(default=None)
114+
help = fields.String(default=None, missing=None)
115+
short_help = fields.String(default=None, missing=None)
114116
arguments = fields.List(fields.Nested(ArgumentSchema), missing=list)
115117
options = fields.List(fields.Nested(OptionSchema), missing=list)
116118
stages = fields.List(fields.Nested(AliasStageSchema), data_key="stage")

src/mario/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def run(ctx, **cli_params):
8080

8181
params = alias.arguments + alias.options
8282
return click.Command(
83-
name=alias.name, params=params, callback=click.pass_context(run)
83+
name=alias.name, params=params, callback=click.pass_context(run), short_help=alias.short_help, help=alias.help
8484
)
8585

8686

0 commit comments

Comments
 (0)