Skip to content

Conversation

@weibullguy
Copy link
Member

This PR adds a new function to split a multi-sentence summary into the first sentence, which becomes the summary, and the remaining sentences which get prepended to the long description.

Fixes #283.

@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: convention Relates to docstring format convention U: high labels May 11, 2025
@weibullguy weibullguy merged commit 1b576ae into master May 11, 2025
7 checks passed
@weibullguy weibullguy deleted the fix/multi_sentence_summary branch May 11, 2025 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C: convention Relates to docstring format convention P: bug PEP 257 violation or existing functionality that doesn't work as documented U: high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Multiple sentences in multi-line docstring summary

2 participants