From 7cf817ca892a7618aa44fbeb51db36672144a618 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 3 Jan 2023 12:21:42 +0000 Subject: [PATCH 1/4] Update code style docs to point to the contrib page, not repeat it --- docs/code_style.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/code_style.md b/docs/code_style.md index 3aa7d0d741ba..0ecc2540edcf 100644 --- a/docs/code_style.md +++ b/docs/code_style.md @@ -13,23 +13,14 @@ The necessary tools are: - [ruff](https://github.com/charliermarsh/ruff), which can spot common errors; and - [mypy](https://mypy.readthedocs.io/en/stable/), a type checker. -Install them with: - -```sh -pip install -e ".[lint,mypy]" -``` - -The easiest way to run the lints is to invoke the linter script as follows. - -```sh -scripts-dev/lint.sh -``` +See [the contributing guide](../contributing_guide.md#run-the-linters) for instructions +on how to install the above tools and run the linters. It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run `mypy` -on save as they take a while and can be very resource intensive. +on save as it take a while and can be very resource intensive. ## General rules From eb9ca6cfbe0fd6c43e03d5fb44af6e25ee277620 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 3 Jan 2023 12:31:16 +0000 Subject: [PATCH 2/4] changelog --- changelog.d/14773.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/14773.doc diff --git a/changelog.d/14773.doc b/changelog.d/14773.doc new file mode 100644 index 000000000000..0992444be07d --- /dev/null +++ b/changelog.d/14773.doc @@ -0,0 +1 @@ +Remove duplicate commands from the Code Style documentation page; point to the Contributing Guide instead. \ No newline at end of file From 3e1db1f61b722bf50db70ec5e59dae9674256ab5 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 11 Jan 2023 07:37:40 -0500 Subject: [PATCH 3/4] Typo fix. Co-authored-by: reivilibre --- docs/code_style.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/code_style.md b/docs/code_style.md index 0ecc2540edcf..97f23874dba7 100644 --- a/docs/code_style.md +++ b/docs/code_style.md @@ -20,7 +20,7 @@ It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run `mypy` -on save as it take a while and can be very resource intensive. +on save as it takes a while and can be very resource intensive. ## General rules From 7f73298cb4d7328e5098825c2eaefe21dfd293f7 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 11 Jan 2023 13:58:32 +0000 Subject: [PATCH 4/4] Fix link to contributing guide section --- docs/code_style.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/code_style.md b/docs/code_style.md index 97f23874dba7..026001b8a3cf 100644 --- a/docs/code_style.md +++ b/docs/code_style.md @@ -13,7 +13,7 @@ The necessary tools are: - [ruff](https://github.com/charliermarsh/ruff), which can spot common errors; and - [mypy](https://mypy.readthedocs.io/en/stable/), a type checker. -See [the contributing guide](../contributing_guide.md#run-the-linters) for instructions +See [the contributing guide](development/contributing_guide.md#run-the-linters) for instructions on how to install the above tools and run the linters. It's worth noting that modern IDEs and text editors can run these tools