fix: do not split summary on a period inside an inline literal - #363
Open
Sanjays2402 wants to merge 1 commit into
Open
fix: do not split summary on a period inside an inline literal#363Sanjays2402 wants to merge 1 commit into
Sanjays2402 wants to merge 1 commit into
Conversation
do_split_summary treated any token ending in '.' as the end of the summary sentence, so a docstring containing an inline literal such as ``.. deprecated::`` was split in the middle of the literal, producing invalid reST. Track whether the text seen so far is inside an unclosed inline literal (an odd number of double-backtick markers) and skip the sentence break in that case, mirroring the existing ABBREVIATIONS false-positive guard. Adds a regression test covering both a literal-only summary and a literal followed by a genuine second sentence.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #353.
do_split_summaryended the summary at any token ending in., so a docstring containing an inline literal like``.. deprecated::``was split in the middle of the literal, producing invalid reST. It now skips the sentence break while inside an unclosed inline literal (odd number of``markers), mirroring the existingABBREVIATIONSfalse-positive guard.Regression test fails without the source change and passes with it; the rest of the suite is unchanged (same 10 pre-existing
test_do_format_codefailures before and after).