Clarify that Black runs with --safe by default (#3378)

[etc/vim.git] / docs / contributing / the_basics.md

diff --git a/docs/contributing/the_basics.md b/docs/contributing/the_basics.md
index 9a639731073d871b6410cc4e1d45defac82abb88..9325a9e44edc83dcd0b879601812b188ce962219 100644 (file)
--- a/docs/contributing/the_basics.md
+++ b/docs/contributing/the_basics.md
@@ -30,9 +30,6 @@ the root of the black repo:
 
 # Optional Fuzz testing
 (.venv)$ tox -e fuzz
 
 # Optional Fuzz testing
 (.venv)$ tox -e fuzz

-
-# Optional CI run to test your changes on many popular python projects
-(.venv)$ black-primer [-k -w /tmp/black_test_repos]

 ```
 
 ### News / Changelog Requirement
 ```
 
 ### News / Changelog Requirement


@@ -55,7 +52,9 @@ go back and workout what to add to the `CHANGES.md` for each release.
 
 If a change would affect the advertised code style, please modify the documentation (The
 _Black_ code style) to reflect that change. Patches that fix unintended bugs in
 
 If a change would affect the advertised code style, please modify the documentation (The
 _Black_ code style) to reflect that change. Patches that fix unintended bugs in

-formatting don't need to be mentioned separately though.
+formatting don't need to be mentioned separately though. If the change is implemented
+with the `--preview` flag, please include the change in the future style document
+instead and write the changelog entry under a dedicated "Preview changes" heading.

 
 ### Docs Testing
 
 
 ### Docs Testing
 


@@ -67,18 +66,6 @@ If you make changes to docs, you can test they still build locally too.
 (.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
 ```
 
 (.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
 ```
 

-## black-primer
-
-`black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
-if we get source code changes. It will error on formatting changes or errors. Please run
-before pushing your PR to see if you get the actions you would expect from _Black_ with
-your PR. You may need to change
-[primer.json](https://github.com/psf/black/blob/main/src/black_primer/primer.json)
-configuration for it to pass.
-
-For more `black-primer` information visit the
-[documentation](./gauging_changes.md#black-primer).
-

 ## Hygiene
 
 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
 ## Hygiene
 
 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,