Skip to content

Commit a062a15

Browse files
Batalexlwasser
authored andcommitted
docs: Remove blue mentions
1 parent 8c43e0d commit a062a15

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

package-structure-code/code-style-linting-format.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
* pyOpenSci requires authors to follow PEP 8 code format guidelines
88
* Setting up a code formatters like Black and isort will help you enforce PEP 8 style guidelines and also consistent, readable code format
9-
* Some commonly used tools are: Black/Blue, Isort, flake8, ruff
9+
* Some commonly used tools are: Black, Isort, flake8, Ruff
1010
* You can also setup pre-commit hooks which will run code formatters locally
1111
each time you make a commit.
1212
* [precommit.ci](https://pre-commit.ci/) is a bot that you can add to your GitHub repository. It will automagically apply code format to every PR using the tools specified in your pre-commit-config.yaml file. It can save significant time and make contributions easier for new contributors.
@@ -86,15 +86,15 @@ You will learn more about Black below.
8686

8787
### Black and Blue
8888

89-
[Black](https://black.readthedocs.io/en/stable/) and [Blue](https://blue.readthedocs.io/en/latest/) (which wraps around Black) are code
90-
formatters. Both Black and Blue will automagically (and _unapologetically_)
89+
[Black](https://black.readthedocs.io/en/stable/) is a code
90+
formatter. Black will automagically (and _unapologetically_)
9191
fix spacing issues and ensure code format is consistent throughout your
92-
package. Black and Blue also generally adhere to PEP 8 style guidelines with
92+
package. Black also generally adhere to PEP 8 style guidelines with
9393
some exceptions. A few examples of those exceptions are below:
9494

9595
- Black defaults to a line length of 88 (79 + 10%) rather than the 79 character `PEP 8` specification. However, line length is a setting can be manually overwritten in your Black configuration.
96-
- Black and Blue will not adjust line length in your comments or docstrings.
97-
- Neither tool will review and fix import order (you need _isort_ or _Ruff_ to do that - see below).
96+
- Black will not adjust line length in your comments or docstrings.
97+
- This tool will not review and fix import order (you need _isort_ or _Ruff_ to do that - see below).
9898

9999
Blue addresses a few format decisions in Black that some maintainers do not like.
100100
[You can compare the differences here](https://blue.readthedocs.io/en/latest/#so-what-s-different) and decide which tool you prefer!
@@ -104,7 +104,7 @@ If you are interested in seeing how Black will format your code, you can
104104
use the [Black playground](https://black.vercel.app/)
105105
```
106106

107-
Using a code formatter like Black or Blue will leave you more time to work on
107+
Using a code formatter like Black will leave you more time to work on
108108
code function rather than worry about format.
109109

110110
### flake8 for linting code in Python packages
@@ -225,7 +225,7 @@ select = [
225225
"I", # isort
226226
]
227227
ignore = [
228-
"E501", # line >79, handled by black/blue
228+
"E501", # line >79, handled by black
229229
]
230230
```
231231

@@ -411,7 +411,7 @@ pyOpenSci suggests setting up a linter and a code styler for
411411
your package, regardless of whether you use pre-commit hooks, CI
412412
or other infrastructure to manage code format. Setting up these
413413
tools will give you automatic feedback about your code's
414-
structure as you (or a contributor) write it. And using tools
415-
like black or blue that format code for you, reduce effort that
414+
structure as you (or a contributor) write it. And using a tool
415+
like black that format code for you, reduce effort that
416416
you need to make surrounding decisions around code format and
417417
style.

0 commit comments

Comments
 (0)