Skip to content
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

Jump to bottom

Rebase of #629; allow use of page break to split docstring-based helptext #1091

Merged
merged 2 commits into from
Aug 27, 2018
Merged

Rebase of #629; allow use of page break to split docstring-based helptext #1091

merged 2 commits into from
Aug 27, 2018

Commits on Aug 15, 2018

  1. Add ability to truncate help text in docstrings. 

    I use docstrings in all of my functions to document function arguments
so it makes me sad that I couldn't exclude :param: and other tags from
my command help texts.

Here I am introducing the ability for Click to truncate help text in
docstrings using the \f form feed escaped character. I chose it
randomly.
    @Robpol86 @sirosen
    Robpol86 authored and sirosen committed Aug 15, 2018
    Configuration menu
    Copy the full SHA
    93c371d View commit details
    Browse the repository at this point in the history

  2. Add requested comment for clarity 

    closes pallets#629
    @sirosen
    sirosen committed Aug 15, 2018
    Configuration menu
    Copy the full SHA
    f9e0dbe View commit details
    Browse the repository at this point in the history