File get-short-help.patch of Package python-click-man.19568
Index: click-man-0.4.1/click_man/core.py
===================================================================
--- click-man-0.4.1.orig/click_man/core.py
+++ click-man-0.4.1/click_man/core.py
@@ -16,6 +16,14 @@ import click
from .man import ManPage
+
+def get_short_help_str(command, limit=45):
+ """
+ Gets short help for the command or makes it by shortening the long help string.
+ """
+ return command.short_help or command.help and click.utils.make_default_short_help(command.help, limit) or ''
+
+
def generate_man_page(ctx, version=None):
"""
Generate documentation for the given command.
@@ -29,14 +37,14 @@ def generate_man_page(ctx, version=None)
# Create man page with the details from the given context
man_page = ManPage(ctx.command_path)
man_page.version = version
- man_page.short_help = ctx.command.get_short_help_str()
+ man_page.short_help = get_short_help_str(ctx.command)
man_page.description = ctx.command.help
man_page.synopsis = ' '.join(ctx.command.collect_usage_pieces(ctx))
man_page.options = [x.get_help_record(ctx) for x in ctx.command.params if isinstance(x, click.Option)]
commands = getattr(ctx.command, 'commands', None)
if commands:
man_page.commands = [
- (k, v.get_short_help_str()) for k, v in commands.items()
+ (k, get_short_help_str(v)) for k, v in commands.items()
]
return str(man_page)