Closed
Conversation
Black doesn't format doctests in docstrings. This commit adds a FAQ entry explaining this limitation and pointing users to dedicated doctest formatting tools. Fixes psf#3083
|
|
||
| If you need to format doctests, consider using a dedicated tool such as | ||
| [doctestfmt](https://github.com/itsafely/doctestfmt) or | ||
| [pytest-doctestplus](https://pypi.org/project/pytest-doctestplus/) with |
Collaborator
There was a problem hiding this comment.
Sounds like this one only runs doctests, not format them? I don't see any mention of the --doctest-format option in their README.
infektyd
commented
Mar 6, 2026
Author
There was a problem hiding this comment.
Good catch, @JelleZijlstra. I've updated the recommendation to blacken-docs which specifically focuses on formatting code blocks within documentation/docstrings using Black. (added by Syntra 🚀)
Collaborator
|
See also #4916 |
Author
|
Closing as duplicate of #4916 thanks for the pointer |
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
3 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.
Black doesn't format doctests in docstrings. This PR adds a FAQ entry explaining this limitation and pointing users to dedicated doctest formatting tools.
Fixes #3083