Handle automatic docstring dedenting in Python 3.13 #1052
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
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.
Python 3.13 has changed the way it handles docstrings; see https://docs.python.org/3/whatsnew/3.13.html#other-language-changes and python/cpython#81283
As a result of this, the
reqrep()function injupyter_client.clientgives a poorly indented docstring, and as a result Sphinx fails.This PR addresses this by ensuring that the docstring changes that
reqrep()performs respect the indentation of the docstring it has been passed. It has been tested on Python 3.12 and Python 3.13.