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

Protect against indented multi-line descriptions #21

Merged
merged 2 commits into from Feb 9, 2021
Merged

Protect against indented multi-line descriptions #21

merged 2 commits into from Feb 9, 2021

Commits on Feb 9, 2021

  1. Protect against indented multi-line descriptions 

    Sphinx will happily e.g. turn the following into a <blockquote> when
outputting HTML, because the leading indentation makes it look like one.

```python
    list_parser = subparsers.add_parser(
        'list',
        help="List available configurations from config directory",
        description="""
            List available configurations from config directory with the
            extension ".cfg". Use option ``--config-dir`` to use a
            specific config directory.
        """)
```

Python's `inspect.cleandoc()` function was meant to handle this case,
making sure that any excess indentation is stripped away.
    @dgw
    dgw committed Feb 9, 2021
    Configuration menu
    Copy the full SHA
    52ecfe0 View commit details
    Browse the repository at this point in the history

  2. Update changelog with blockquote fix

    @dgw
    dgw committed Feb 9, 2021
    Configuration menu
    Copy the full SHA
    fd7f9af View commit details
    Browse the repository at this point in the history