Docs: Mentioned doctest formatting (Closes #3083)#4908
Closed
SnippyCodes wants to merge 4 commits into
Closed
Conversation
c9b3b6b to
3815733
Compare
Collaborator
|
This PR has some issues. Most notably, I'm inclined to believe that this PR is AI-generated. While using AI in itself isn't forbidden, we do expect you to look over what the AI did, that you've reviewed the code it writes, and that submitted PRs are up to our code standards and in line with the project expectations and requirements. Unfortunately, your contribution does not meet this bar. We don't have the resources to review AI-generated PRs, which are often of low quality. If you aren't already aware:
Again, you can use AIs as part of your work, but you are responsible for verifying their output and that they do not impact others' ability to contribute productively. Thank you for your understanding. |
4 tasks
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.
Description
This Pull Request addresses Issue #3083 by updating the documentation to mention third-party tools that can be used to format code examples embedded in docstrings (doctests).
Since Black does not format doctests by default, this documentation clarifies for users how to achieve consistent formatting across their entire project.
I have added a new section, "Formatting Doctests," to
docs/usage_and_configuration/the_basics.md, recommending the use of theblacken-docstool.Closes #3083
Checklist - did you ...
--previewstyle, following thestability policy?
CHANGES.mdif necessary?