Added documentation for doctest formatting tools #4916
+107
−0
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
…grations index to match (psf#4914)
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Collaborator
|
I'm a bit hesitant about advertising small third-party tools that integrate directly with Black. One issue that comes to mind (beyond the obvious security concerns) is #4757, where a similar small project started crashing after we changed our public API, which is not stable or covered under semver (see #779). Do the maintainers of these packages know that we're considering linking to them on our docs? |
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.
Description
Addresses issue #3083. Adds a documentation page under integration for tools that can apply Black formatting to doctests. This is meant to inform users of 3rd party tools that cover functionality not covered by Black. New doc page includes a brief description of blackdoc and blacken-docs. The integrations index page was also updated to list this new page.
Checklist - did you ...
Implement any code style changes under the
--previewstyle, following thestability policy?
Add an entry in
CHANGES.mdif necessary?Add / update tests if necessary?
Add new / update outdated documentation?
Updated
CHANGES.mdConfirmed documentation pages build as expected