Python(fix): clean docstrings captured in pytest#658
Merged
Conversation
Contributor
|
Python docs preview: https://sift-stack.github.io/sift/python/pr-658/ Deployed from |
wei-qlu
approved these changes
Jun 26, 2026
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
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.
The pytest plugin stored test step descriptions straight from
__doc__. For leaf steps (test functions) the raw docstring was used as-is, so an indented multi-line docstring kept its source indentation on every line after the first, plus surrounding blank lines. For hierarchy parents (package/module/class) only.strip()was applied, which trims the ends but leaves interior indentation in place.Both extraction points now use
inspect.getdoc, which dedents interior lines, trims surrounding blank lines, and falls back to an inherited docstring when the object itself has none. The existing try/except guards and the empty-to-Nonebehavior are preserved.The leaf-step test is updated to assert the stored description against the dedented literal and to confirm it differs from the raw
__doc__, so a regression back to raw storage fails the test.