Protect against indented multi-line descriptions #21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgw
added a commit
to sopel-irc/sopel
that referenced
this pull request
Nov 15, 2020
One left in sopel.cli.config, which is better fixed by a small patch to sphinxcontrib.autoprogram if the patch is accepted. (See sphinx-contrib/autoprogram#21)
dahlia
reviewed
Dec 3, 2020
|
Done. Tried to match style of previous entries, and added a new extlinks role for PRs while I was in there. 😸 |
|
Oh, I just saw the merge conflict. Would you like me to rebase, merge from master, or do nothing and let you resolve it yourself? |
|
Decided to clean up the conflict by rebasing. Looks like CI has been failing on |
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.
|
@langston-barrett Should be good to go. I happened to be in between meetings! Maybe I should try to recruit you to help move one of my own projects to Actions 😏 |
|
@dgw Excellent! Thank you! |
dgw
added a commit
to sopel-irc/sopel
that referenced
this pull request
Jun 30, 2021
One left in sopel.cli.config, which is better fixed by a small patch to sphinxcontrib.autoprogram if the patch is accepted. (See sphinx-contrib/autoprogram#21)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sphinx will happily e.g. turn the following into a
<blockquote>when outputting HTML, because the leading indentation makes it look like one.Python's
inspect.cleandoc()function was meant to handle this case, making sure that any excess indentation is stripped away.@Exirel, this will fix the documentation rendering issue I pinged you about on IRC earlier.