fix: Allow Raises and Warns sections to start with a newline #149
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
According to the it's possible to start a description with a newline. However, this did not work properly for Raises and Warns sections, because of a stray space in the regex to split the annotation and its description.
|
Nice catch, thanks a lot! |
According to the documentation it's possible to start a description with a newline. However, this did not work properly for Raises and Warns sections, because of a stray space in the regex to split the annotation and its description.
viccie30
force-pushed
the
fix-newline-in-raises-and-warns
branch
from
a94932f
to
78a5ad3
Compare
|
I just realised I missed a word in my commit message, so I've force pushed the same commit with the missing word in the message added. |
…/griffe into fix-newline-in-raises-and-warns
|
I've added a test for it. LGTM, WDYT? |
|
Looks good to me as well! |
|
I've also found out warnings sections were never parsed as such. Just released both fixes as 0.27.1. |
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.
According to the documentation it's possible to start a description with a newline.
However, this did not work properly for Raises and Warns sections, because of a stray space in the regex to split the annotation and its description.