Skip to content

Commit 7aa9f3a

Browse files
committed
Minor misc docs rewordings
Signed-off-by: cobalt <[email protected]>
1 parent cf4de0e commit 7aa9f3a

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

.github/ISSUE_TEMPLATE/style_issue.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ def f():
2929
```python
3030
def f(
3131
):
32+
"Make sure this code is blackened"""
3233
pass
3334
```
3435

AUTHORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ Multiple contributions by:
142142
- [Pablo Galindo](mailto:[email protected])
143143
- [Paul Ganssle](mailto:[email protected])
144144
- [Paul Meinhardt](mailto:[email protected])
145+
- [Paul S. Reid](mailto:[email protected])
145146
- [Peter Bengtsson](mailto:[email protected])
146147
- [Peter Grayson](mailto:[email protected])
147148
- [Peter Stensmyr](mailto:[email protected])

docs/contributing/the_basics.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ files in the `tests/data/cases` directory. These files consist of up to three pa
8888
If this is omitted, the test asserts that _Black_ will leave the input code unchanged.
8989

9090
_Black_ has two pytest command-line options affecting test files in `tests/data/` that
91-
are split into an input part, and an output part, separated by a line with`# output`.
91+
are split into an input part, and an output part, separated by a line with `# output`.
9292
These can be passed to `pytest` through `tox`, or directly into pytest if not using
9393
`tox`.
9494

@@ -128,11 +128,17 @@ does not need to go back and workout what to add to the `CHANGES.md` for each re
128128

129129
### Style Changes
130130

131+
Please familiarize yourself with our [stability policy](labels/stability-policy).
132+
Therefore, most style changes must be added to the `--preview` style. Exceptions are
133+
fixing crashes or changes that would not affect an already-formatted file.
134+
131135
If a change would affect the advertised code style, please modify the documentation (The
132136
_Black_ code style) to reflect that change. Patches that fix unintended bugs in
133-
formatting don't need to be mentioned separately though. If the change is implemented
134-
with the `--preview` flag, please include the change in the future style document
135-
instead and write the changelog entry under the dedicated "Preview style" heading.
137+
formatting don't need to be mentioned separately.
138+
139+
If the change is implemented with the `--preview` flag, please include the change in the
140+
Future Style document instead and write the changelog entry under the dedicated "Preview
141+
style" heading.
136142

137143
### Docs Testing
138144

docs/guides/introducing_black_to_your_project.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ $ git config blame.ignoreRevsFile .git-blame-ignore-revs
4545

4646
**The one caveat is that some online Git-repositories do not yet support ignoring
4747
revisions using their native blame UI.** So blame information will be cluttered with a
48-
reformatting commit on those platforms.
49-
[GitHub supports `.git-blame-ignore-revs`](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view)
50-
by default in blame views however.
51-
[GitLab supports this since version 17.10](https://about.gitlab.com/releases/2025/03/20/gitlab-17-10-released/#ignore-specific-revisions-in-git-blame)
48+
reformatting commit on those platforms. However,
49+
[GitHub](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view)
50+
and
51+
[GitLab (since version 17.10)](https://about.gitlab.com/releases/2025/03/20/gitlab-17-10-released/#ignore-specific-revisions-in-git-blame)
52+
both support `.git-blame-ignore-revs` in blame views by default.

0 commit comments

Comments
 (0)