Skip to content

Commit

Permalink
Updates Docs With Code Options
Browse files Browse the repository at this point in the history
Updates the docs to remove the warning about the code options bug, and
adds a changelog entry.

Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
  • Loading branch information
HassanAbouelela committed May 26, 2021
1 parent 6db4387 commit 6fb6ca1
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 7 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions CHANGES.md
Expand Up @@ -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_

Expand Down
7 changes: 0 additions & 7 deletions docs/usage_and_configuration/the_basics.md
Expand Up @@ -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
Expand Down

0 comments on commit 6fb6ca1

Please sign in to comment.