chore(docs): add blacken-docs with 80 char line length for code blocks#4622
Open
Br1an67 wants to merge 2 commits intolitestar-org:mainfrom
Open
chore(docs): add blacken-docs with 80 char line length for code blocks#4622Br1an67 wants to merge 2 commits intolitestar-org:mainfrom
Br1an67 wants to merge 2 commits intolitestar-org:mainfrom
Conversation
- Fix multi-line caption in docs/usage/routing/handlers.rst - Fix inconsistent indentation in docs/migration/flask.rst - Apply blacken-docs formatting to all code blocks (80 char line length)
github-actions
bot
added
area/docs
Br1an67
force-pushed
the
fix/issue-3211-blacken-docs-line-length
branch
from
ade3f96 to
cd80850
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4622 +/- ##
=======================================
Coverage 97.87% 97.87%
=======================================
Files 292 292
Lines 15063 15077 +14
Branches 1703 1703
=======================================
+ Hits 14743 14757 +14
Misses 184 184
Partials 136 136 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Fixes #3211
Description
Add
blacken-docsto the pre-commit configuration with a line length of 80 characters to prevent documentation code blocks from becoming too wide and requiring horizontal scrolling.This change adds the
adamchainz/blacken-docspre-commit hook configured with--line-length=80to format Python code blocks in RST and Markdown documentation files.Closes
Fixes #3211
📚 Documentation preview 📚: https://litestar-org.github.io/litestar-docs-preview/4622