Skip to content

docs: mention blacken-docs for doctest formatting #5054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SadManFahIm wants to merge 1 commit into from
+8 −0
Closed

docs: mention blacken-docs for doctest formatting #5054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/the_black_code_style/current_style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,14 @@ end of the docstring are removed. All leading tabs are converted to spaces, but
inside text are preserved. Whitespace leading and trailing one-line docstrings is
removed.

### Doctest formatting

_Black_ does not format code within doctests. If you want to format doctest code
snippets, you can use one of the following tools:

- [blacken-docs](https://github.com/adamchainz/blacken-docs): reformats code blocks in
documentation files and docstrings.

### Numeric literals

_Black_ standardizes most numeric literals to use lowercase letters for the syntactic
Expand Down