From 78cbdc3e4233135bf72a65a04e0d065bc0a1de28 Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Thu, 14 Sep 2023 16:01:00 -0700 Subject: [PATCH] chore: changing one word (disablement -> disabling) (#25291) --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- docs/docs/contributing/hooks-and-linting.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b31d64405..bcc523115c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2708,7 +2708,7 @@ under the License. - [#17045](https://github.com/apache/superset/pull/17045) docs: add vscode linter instructions to CONTRIBUTING.md (@suddjian) - [#16993](https://github.com/apache/superset/pull/16993) style: Update text for SLL Tooltip (@gabester78) - [#16959](https://github.com/apache/superset/pull/16959) chore(Dashboard): Implement dedicated message for missing dataset (@geido) -- [#17016](https://github.com/apache/superset/pull/17016) docs(pylint): Add context about disablement of Pylint messages (@john-bodley) +- [#17016](https://github.com/apache/superset/pull/17016) docs(pylint): Add context about disabling of Pylint messages (@john-bodley) - [#17009](https://github.com/apache/superset/pull/17009) chore: bump superset-ui 0.18.10 (@zhaoyongjie) - [#16974](https://github.com/apache/superset/pull/16974) refactor(filterset): improve response body (@ofekisr) - [#16999](https://github.com/apache/superset/pull/16999) chore: no direct use of supersetTheme (or bad LESS vars) in SqlEditor (@rusackas) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94573f2a9e..10a60d65db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -720,7 +720,7 @@ We use [Pylint](https://pylint.org/) for linting which can be invoked via: tox -e pylint ``` -In terms of best practices please avoid blanket disablement of Pylint messages globally (via `.pylintrc`) or top-level within the file header, albeit there being a few exceptions. Disablement should occur inline as it prevents masking issues and provides context as to why said message is disabled. +In terms of best practices please avoid blanket disabling of Pylint messages globally (via `.pylintrc`) or top-level within the file header, albeit there being a few exceptions. Disabling should occur inline as it prevents masking issues and provides context as to why said message is disabled. Additionally, the Python code is auto-formatted using [Black](https://github.com/python/black) which is configured as a pre-commit hook. There are also numerous [editor integrations](https://black.readthedocs.io/en/stable/integrations/editors.html) diff --git a/docs/docs/contributing/hooks-and-linting.mdx b/docs/docs/contributing/hooks-and-linting.mdx index 8539ecb6b2..509a12ac11 100644 --- a/docs/docs/contributing/hooks-and-linting.mdx +++ b/docs/docs/contributing/hooks-and-linting.mdx @@ -39,7 +39,7 @@ We use [Pylint](https://pylint.org/) for linting which can be invoked via: tox -e pylint ``` -In terms of best practices please avoid blanket disablement of Pylint messages globally (via `.pylintrc`) or top-level within the file header, albeit there being a few exceptions. Disablement should occur inline as it prevents masking issues and provides context as to why said message is disabled. +In terms of best practices please avoid blanket disabling of Pylint messages globally (via `.pylintrc`) or top-level within the file header, albeit there being a few exceptions. Disabling should occur inline as it prevents masking issues and provides context as to why said message is disabled. Additionally, the Python code is auto-formatted using [Black](https://github.com/python/black) which is configured as a pre-commit hook. There are also numerous [editor integrations](https://black.readthedocs.io/en/stable/integrations/editors.html)