docs: mention tools for doctests formatting in FAQ#5010
Closed
thakoreh wants to merge 1 commit into
Closed
Conversation
Add a new FAQ entry addressing Black's limitation with doctest formatting. Mention alternative tools (docformatter, doctestfmt) that users can use alongside Black to format doctests in docstrings. Closes psf#3083
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
1 participant
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.
Summary
This PR addresses issue #3083 by adding a new FAQ entry that documents Black's limitation with doctest formatting and mentions alternative tools users can use.
Changes
Motivation
Users often expect Black to format doctests within docstrings, but this is not currently supported. This FAQ entry helps users understand this limitation and provides actionable alternatives.
Closes #3083