Repository navigation
Allow epilog without indentation. #2881
Description
Activity
I will keep an eye on this to see if it gathers community support.
It has my support! Is there a simple workaround for that in the meantime?
I just ran into a desire for this and solved it by making a customized copy of
help_optionto try to avoid some of the less clearly public APIs.def help_option(*, epilog: str | None = None) -> _t.Callable[[FC], FC]: """A variant of the built-in click ``--help`` option. Unlike ``click.help_option``, this decorator accepts its own `epilog` text which is printed *without indentation* after help text. """ def show_help(ctx: click.Context, param: click.Parameter, value: bool) -> None: """Callback that print the help page on ``<stdout>`` and exits.""" if value and not ctx.resilient_parsing: click.echo(ctx.get_help(), color=ctx.color) if epilog is not None: formatter = ctx.make_formatter() formatter.write_text(epilog) click.echo("\n" + formatter.getvalue().rstrip("\n"), color=ctx.color) ctx.exit() return click.option( "-h", "--help", help="Show this message and exit.", callback=show_help, is_eager=True, expose_value=False, is_flag=True, )
I'm not convinced in favor of a "dedent epilog" option -- that seems much too use-case specific. But I would like to be able to hook into this process to customize it more easily. In my example, I had to reproduce the whole help opt, with all of its details.
When adding an epilog to a group, the text appears to be indented under the commands list.
I want the entire epilog to not be indented. Perhaps
indent-epilog=False?