Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation on how to enable specific checkers and how to silence specific warnings #37

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

nfx
Copy link
Collaborator

@nfx nfx commented Apr 19, 2024

No description provided.

@nfx nfx merged commit 9c71d95 into main Apr 19, 2024
8 checks passed
@nfx nfx deleted the docs/disable branch April 19, 2024 14:15
nfx added a commit that referenced this pull request Apr 19, 2024
* Added documentation on how to enable specific checkers and how to silence specific warnings ([#37](#37)). The latest release introduces new documentation in the README file for enabling specific checkers and disabling specific warnings for the pylint plugin for Databricks. The plugin offers checkers such as `databricks-airflow`, `databricks-dbutils`, `databricks-legacy`, `databricks-notebooks`, `spark`, and `mocking`, each with unique checks and codes. Users can use these checkers by adding the corresponding module name to the `load-plugins` configuration in their `pylintrc` or `pyproject.toml` file. The release also explains how to disable certain checks on specific lines using a comment with the `disable` directive followed by the corresponding symbol. Additionally, it includes information on how to use the Databricks SDK instead of internal APIs, legacy CLI, and dbutils. The `docs.py` script has also been updated with the new instructions on how to enable or disable specific checkers and warnings.
@nfx nfx mentioned this pull request Apr 19, 2024
nfx added a commit that referenced this pull request Apr 19, 2024
* Added documentation on how to enable specific checkers and how to
silence specific warnings
([#37](#37)). The
latest release introduces new documentation in the README file for
enabling specific checkers and disabling specific warnings for the
pylint plugin for Databricks. The plugin offers checkers such as
`databricks-airflow`, `databricks-dbutils`, `databricks-legacy`,
`databricks-notebooks`, `spark`, and `mocking`, each with unique checks
and codes. Users can use these checkers by adding the corresponding
module name to the `load-plugins` configuration in their `pylintrc` or
`pyproject.toml` file. The release also explains how to disable certain
checks on specific lines using a comment with the `disable` directive
followed by the corresponding symbol. Additionally, it includes
information on how to use the Databricks SDK instead of internal APIs,
legacy CLI, and dbutils. The `docs.py` script has also been updated with
the new instructions on how to enable or disable specific checkers and
warnings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant