From 6fb6ca13e0c709f55a4d8ad97154b39f4972711e Mon Sep 17 00:00:00 2001 From: Hassan Abouelela Date: Wed, 26 May 2021 05:42:27 +0300 Subject: [PATCH] Updates Docs With Code Options Updates the docs to remove the warning about the code options bug, and adds a changelog entry. Signed-off-by: Hassan Abouelela --- AUTHORS.md | 1 + CHANGES.md | 1 + docs/usage_and_configuration/the_basics.md | 7 ------- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index cb79dec3de3..8d112ea6795 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -68,6 +68,7 @@ Multiple contributions by: - Gustavo Camargo - hauntsaninja - [Hadi Alqattan](mailto:alqattanhadizaki@gmail.com) +- [Hassan Abouelela](mailto:hassan@hassanamr.com) - [Heaford](mailto:dan@heaford.com) - [Hugo Barrera](mailto::hugo@barrera.io) - Hugo van Kemenade diff --git a/CHANGES.md b/CHANGES.md index 34fa1a2092a..0c4b2a38e79 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -8,6 +8,7 @@ - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply `.gitignore` rules like `git` does) (#2225) - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227) +- Fixed option usage when using the `--code` flag (#2259) ### _Blackd_ diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index 0b2cd3b3544..c5e17e5a521 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -68,13 +68,6 @@ $ black --code "print ( 'hello, world' )" print("hello, world") ``` -```{warning} ---check, --diff, and --safe / --fast have no effect when using -c / --code. Safety -checks normally turned on by default that verify _Black_'s output are disabled as well. -This is a bug which we intend to fix eventually. More details can be found in this [bug -report](https://github.com/psf/black/issues/2104). -``` - ### Writeback and reporting By default _Black_ reformats the files given and/or found in place. Sometimes you need