From ac6ecc863e6fddd353355072e44b2c410b60c438 Mon Sep 17 00:00:00 2001 From: Jonas Haag Date: Tue, 15 Aug 2023 17:20:36 +0200 Subject: [PATCH 1/5] Add Black PyCharm 2023.2 integration instructions --- docs/integrations/editors.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index ff563068e79..b4084bf4eca 100644 --- a/docs/integrations/editors.md +++ b/docs/integrations/editors.md @@ -12,6 +12,7 @@ Options include the following: There are three different ways you can use _Black_ from PyCharm: +1. Using the built-in _Black_ integration (PyCharm 2023.2 and later) 1. As local server using the BlackConnect plugin 1. As external tool 1. As file watcher @@ -21,6 +22,16 @@ The first option is the simplest to set up and formats the fastest (by spinning startup cost on subsequent formats), but if you would prefer to not install a third-party plugin or blackd's extra dependencies, the other two are also great options. +### Built-in _Black_ integration + +1. Install `black`. + + ```console + $ pip install black + ``` + +1. Go to `Preferences or Settings -> Tools -> Black` and configure _Black_ to your liking. + ### As local server 1. Install _Black_ with the `d` extra. From 9722db2a95aeff76d951f8ff2205deba925779ca Mon Sep 17 00:00:00 2001 From: Jonas Haag Date: Tue, 15 Aug 2023 17:53:13 +0200 Subject: [PATCH 2/5] Update docs/integrations/editors.md Co-authored-by: Jelle Zijlstra --- docs/integrations/editors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index b4084bf4eca..be58547ec49 100644 --- a/docs/integrations/editors.md +++ b/docs/integrations/editors.md @@ -10,7 +10,7 @@ Options include the following: ## PyCharm/IntelliJ IDEA -There are three different ways you can use _Black_ from PyCharm: +There are several different ways you can use _Black_ from PyCharm: 1. Using the built-in _Black_ integration (PyCharm 2023.2 and later) 1. As local server using the BlackConnect plugin From 0ea66043a5fed31c469c01146f75063b774d9c8f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 15 Aug 2023 15:53:29 +0000 Subject: [PATCH 3/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/integrations/editors.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index be58547ec49..aba98fa8a25 100644 --- a/docs/integrations/editors.md +++ b/docs/integrations/editors.md @@ -30,7 +30,8 @@ third-party plugin or blackd's extra dependencies, the other two are also great $ pip install black ``` -1. Go to `Preferences or Settings -> Tools -> Black` and configure _Black_ to your liking. +1. Go to `Preferences or Settings -> Tools -> Black` and configure _Black_ to your + liking. ### As local server From 0fff3e01e8b61058410aaacb1b4c8719b968cfae Mon Sep 17 00:00:00 2001 From: Jonas Haag Date: Tue, 15 Aug 2023 23:03:04 +0200 Subject: [PATCH 4/5] Update editors.md --- docs/integrations/editors.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index aba98fa8a25..7c62d2cd498 100644 --- a/docs/integrations/editors.md +++ b/docs/integrations/editors.md @@ -12,15 +12,14 @@ Options include the following: There are several different ways you can use _Black_ from PyCharm: -1. Using the built-in _Black_ integration (PyCharm 2023.2 and later) -1. As local server using the BlackConnect plugin -1. As external tool -1. As file watcher - -The first option is the simplest to set up and formats the fastest (by spinning up -{doc}`Black's HTTP server `, avoiding the -startup cost on subsequent formats), but if you would prefer to not install a -third-party plugin or blackd's extra dependencies, the other two are also great options. +1. Using the built-in _Black_ integration (PyCharm 2023.2 and later). + This option is the simplest to set up. +1. As local server using the BlackConnect plugin. + This option formats the fastest. It spins up + {doc}`Black's HTTP server `, + to avoid the startup cost on subsequent formats. +1. As external tool. +1. As file watcher. ### Built-in _Black_ integration From 781a30e83092756e76a8bc75c7829060f51c6811 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 15 Aug 2023 21:36:40 +0000 Subject: [PATCH 5/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/integrations/editors.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index 7c62d2cd498..cebe2b0721e 100644 --- a/docs/integrations/editors.md +++ b/docs/integrations/editors.md @@ -12,12 +12,11 @@ Options include the following: There are several different ways you can use _Black_ from PyCharm: -1. Using the built-in _Black_ integration (PyCharm 2023.2 and later). - This option is the simplest to set up. -1. As local server using the BlackConnect plugin. - This option formats the fastest. It spins up - {doc}`Black's HTTP server `, - to avoid the startup cost on subsequent formats. +1. Using the built-in _Black_ integration (PyCharm 2023.2 and later). This option is the + simplest to set up. +1. As local server using the BlackConnect plugin. This option formats the fastest. It + spins up {doc}`Black's HTTP server `, to + avoid the startup cost on subsequent formats. 1. As external tool. 1. As file watcher.