Improve readability of TestCase docstring in case.py #126378
Closed
Conversation
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
Adjusted the indentation and formatting of the attribute list in the TestCase docstring to improve readability and avoid Sphinx documentation build errors. The attributes `failureException`, `longMessage`, and `maxDiff` are now more clearly presented with reduced indentation, making the list easier to read and avoiding issues with unexpected indentation in Sphinx. No logic or functionality was modified; this change only affects the docstring for documentation purposes.
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
Hi, @maintainers. Could you please add the "skip issue" label to this PR? I don’t have permissions to add labels myself. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adjusted the indentation and formatting of the attribute list in the TestCase docstring to improve readability and avoid Sphinx documentation build errors.
The attributes
failureException,longMessage, andmaxDiffare now more clearly presented with reduced indentation, making the list easier to read and avoiding issues with unexpected indentation in Sphinx.No logic or functionality was modified; this change only affects the docstring for documentation purposes.