Document how users can use linting tools instead of `kedro lint` #1904

ankatiyar · 2022-10-05T15:56:51Z

Signed-off-by: Ankita Katiyar ankitakatiyar2401@gmail.com

Description

Resolves #1620

Development notes

Added a page to the "Development" section documenting how users can use linting tools, specifically black, flake8 and isort to lint their code as a replacement for kedro lint command. Also, added an entry for the page under index.rst and removed mentions of kedro lint from Kedro's command line interface page.

Checklist

Read the contributing guidelines
Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added a description of this change in the RELEASE.md file
Added tests to cover my changes

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

noklam

Good first draft! ⭐️

Questions

What's the difference of isort and black? This is a question that I had for a long time, since black also sort imports, do we actually need both? If so, what's the extra thing that isort does?

ankatiyar · 2022-10-06T12:32:55Z

Good first draft! ⭐️

Questions

What's the difference of isort and black? This is a question that I had for a long time, since black also sort imports, do we actually need both? If so, what's the extra thing that isort does?

Thank you @noklam! The difference between isort and black is that black does format the imports (grouping them etc.) but does not necessarily reorder them alphabetically like isort.
The only thing to add I found while looking this up is that since both isort and black format the imports, while might create conflicts. Setting the isort profile to black (isort <project_root> --profile black ) makes it compatible with black. (I'll add this to the docs draft)

merelcht

Excellent work @ankatiyar ! These docs look great 😄

I've left small suggestions, but I think one thing we should explain in these docs is what black, isort and flake8 do and why we advice people to use them. It's clear why you should lint your code, but not why you should use those specific tools.

merelcht · 2022-10-06T13:32:34Z

docs/source/development/linting.md

+## Set up linting tools
+There are a variety of linting tools available to use
+with your Kedro projects. This guide shows you how to use [`black`](https://github.com/psf/black), [`flake8`](https://gitlab.com/pycqa/flake8), and [`isort`](https://github.com/PyCQA/isort) to lint your Kedro projects.
+- **`black`** is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. Read the full documentation [here](https://black.readthedocs.io/en/stable/).


Suggested change

- **`black`** is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. Read the full documentation [here](https://black.readthedocs.io/en/stable/).

- **`black`** is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. [You can read more in the black documentation](https://black.readthedocs.io/en/stable/).

Making the links a bit more descriptive for accessibility: #1281

Thank you @MerelTheisenQB for the review. I've made the suggested changes in 6c2271d.

docs/source/development/linting.md

jmholzer

Good overall, nice work 🙂 I've left a few comments. The most important thing that I think is missing is information about what the tools do and what problem they solve.

jmholzer · 2022-10-06T13:52:40Z

docs/source/development/linting.md

+```text
+black==22.1.0 # Used for formatting code
+flake8>=3.7.9, <5.0 # Used for linting code
+isort~=5.0 # Used for linting code


It's a nice idea to include instructions for requirements.txt. I think we should avoid specifying versions though as this would mean we have to maintain this section in the future.

Thank you for the review @jmholzer! I've made the suggested changes in 6c2271d

jmholzer · 2022-10-06T14:04:16Z

docs/source/development/linting.md

+# Linting
+
+## Introduction
+Lint, or a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs.


This line refers specifically to the software 'Lint' (https://en.wikipedia.org/wiki/Lint_(software)), so I don't think it is appropriate to use this here.

Suggested change

Lint, or a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs.

Linting tools are used to improve the quality of your code by checking for errors and making sure it meets a stylistic standard before it is run.

jmholzer · 2022-10-06T14:10:25Z

docs/source/development/linting.md

+with your Kedro projects. This guide shows you how to use [`black`](https://github.com/psf/black), [`flake8`](https://gitlab.com/pycqa/flake8), and [`isort`](https://github.com/PyCQA/isort) to lint your Kedro projects.
+- **`black`** is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. Read the full documentation [here](https://black.readthedocs.io/en/stable/).
+- **`flake8`** is a wrapper around [`pep8`](https://pypi.org/project/pep8/), [`pyflakes`](https://pypi.org/project/pyflakes/), and [`mccabe`](https://pypi.org/project/mccabe/). Read the full documentation [here](https://flake8.pycqa.org/en/latest/).
+- **`isort`** is a Python library used to sort imports alphabetically. Read the full documentation [here](https://pycqa.github.io/isort/).


I think the introduction to black, isort and flake8 could be a bit longer, maybe with an example each of what they can do for the reader.

ankatiyar · 2022-10-07T08:55:10Z

docs/source/development/commands_reference.md

-kedro lint
-```
-
-Your project is linted with [`black`](https://github.com/psf/black), [`flake8`](https://gitlab.com/pycqa/flake8) and [`isort`](https://github.com/PyCQA/isort).


#1912 (comment)
@MerelTheisenQB wrt your comment in #1912, should we keep this in for now?

As discussed, removed the changes in this file(docs/source/development/commands_reference.md) from this PR as we are not removing mentions of kedro lint and kedro test from the docs yet. The deprecation warnings for kedro test and kedro lint in docs will be addressed in #1912

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

SajidAlamQB · 2022-10-10T09:46:52Z

docs/source/development/linting.md

+
+## Automating linting with `pre-commit` hooks
+
+You can also automate linting by using [`pre-commit`](https://github.com/pre-commit/pre-commit) hooks.


Suggested change

You can also automate linting by using [`pre-commit`](https://github.com/pre-commit/pre-commit) hooks.

[`pre-commit`](https://github.com/pre-commit/pre-commit) hooks can be used to automate linting.

Sorry, this might be a bit pedantic I think we should avoid starting with 'You can also'

Thanks @SajidAlamQB for the review!
Do you think I could remove the 'also' instead - "You can automate linting by using pre-commit hooks"?
The contribute to kedro docs guidelines mention avoiding passive tense.

Yes, that seems good as well.

Updated in 969c6dc!

merelcht

Great docs! ⭐ 😄

merelcht · 2022-10-10T10:15:42Z

docs/source/development/linting.md

+programming errors and coding style inconsistencies with respect to [PEP 8](https://peps.python.org/pep-0008/),
+and check the cyclomatic complexity of your code base.
+[You can read more in the `flake8` documentation](https://flake8.pycqa.org/en/latest/).
+- **`isort`** is a Python library used to sort imports alphabetically, and automatically separated into sections and by


Suggested change

- **`isort`** is a Python library used to sort imports alphabetically, and automatically separated into sections and by

- **`isort`** is a Python library used to sort imports alphabetically and automatically separate them into sections and by

Made the change in 969c6dc! Thanks!

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

SajidAlamQB

Amazing work these docs are looking good! 🌟

* Add documentation for linting tools Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Revert changes to commands_reference.md Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting docs with suggestions Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting doc Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

…ro-org#1904) * Add documentation for linting tools Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Revert changes to commands_reference.md Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting docs with suggestions Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting doc Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: nickolasrm <nickolasrochamachado@gmail.com>

* Release/0.18.3 (#1856) * Update release version and release notes Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Update missing release notes Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * update vresion Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * update release notes Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Remove comment from code example Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Remove more comments Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add YAML formatting Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add missing import Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Remove even more comments Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Remove more even more comments Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add pickle requirement to extras_require Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Try fix YAML docs Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Try fix YAML docs pt 2 Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix code snippets in docs (#1876) * Fix code snippets Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Separate code blocks Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Lint Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix issue with specifying format for SparkHiveDataSet (#1857) Signed-off-by: jstammers <jimmy.stammers@cgastrategy.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update RELEASE.md (#1883) * Update RELEASE.md * fix broken link * Update RELEASE.md Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com> Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Deprecate `kedro test` and `kedro lint` (#1873) * Deprecating `kedro test` and `kedro lint` Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Deprecate commands Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Make kedro looks prettier * Update Linting Signed-off-by: Nok <nok_lam_chan@mckinsey.com> Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Nok <nok_lam_chan@mckinsey.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix micro package pull from PyPI (#1848) Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update Error message for `VersionNotFoundError` to handle Permission related issues better (#1881) * Update message for VersionNotFoundError Signed-off-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> * Add test for VersionNotFoundError for cloud protocols * Update test_data_catalog.py Update NoVersionFoundError test * minor linting update * update docs link + styling changes * Revert "update docs link + styling changes" This reverts commit 6088e00. * Update test with styling changes * Update RELEASE.md Signed-off-by: ankatiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: ankatiyar <ankitakatiyar2401@gmail.com> Co-authored-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update experiment tracking documentation with working examples (#1893) Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add NHS AI Lab and ReSpo.Vision to companies list (#1878) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Document how users can use pytest instead of kedro test (#1879) * Add best_practices.md with introductory sections Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add pytest and pytest-cov sections Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add pytest-cov coverage report Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add sections on pytest-cov Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add automated_testing to index.rst Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Reformat third-party library names and clean grammar. Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add link to virtual environment docs Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add example of good test naming Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Improve link accessibility Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Improve pytest docs link accessibility Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add reminder link to virtual environment docs Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Fix formatting in link to coverage docs Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Remove reference to /src under 'Run your tests' Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Modify references to <project_name> to <package_name> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Fix sentence structure Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Fix broken databricks doc link Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Capitalise Kedro-Viz in the "Visualize layers" section (#1899) * Capitalised kedro-viz Signed-off-by: yash6318 <yash.agrawal.cse21@iitbhu.ac.in> * capitalised Kedro viz Signed-off-by: yash6318 <yash.agrawal.cse21@iitbhu.ac.in> * Updated set_up_experiment_tracking.md Co-authored-by: Deepyaman Datta <deepyaman.datta@utexas.edu> Signed-off-by: yash6318 <yash.agrawal.cse21@iitbhu.ac.in> Signed-off-by: yash6318 <yash.agrawal.cse21@iitbhu.ac.in> Co-authored-by: Deepyaman Datta <deepyaman.datta@utexas.edu> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix linting on autmated test page (#1906) Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add _SINGLE_PROCESS property to CachedDataSet (#1905) Signed-off-by: Carla Vieira <carlaprv@hotmail.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update the tutorial of "Visualise pipelines" (#1913) * Change a file extention to match the previous article Signed-off-by: dinotuku <kuan.tung@epfl.ch> * Add a missing import Signed-off-by: dinotuku <kuan.tung@epfl.ch> * Change both preprocessed datasets to parquet files Signed-off-by: dinotuku <kuan.tung@epfl.ch> * Change data type to ParquetDataSet for parquet files Signed-off-by: dinotuku <kuan.tung@epfl.ch> * Add a note for installing seaborn if it is not installed Signed-off-by: dinotuku <kuan.tung@epfl.ch> Signed-off-by: dinotuku <kuan.tung@epfl.ch> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Document how users can use linting tools instead of `kedro lint` (#1904) * Add documentation for linting tools Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Revert changes to commands_reference.md Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting docs with suggestions Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Update linting doc Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Make core config accessible in dict get way (#1870) Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Create dependabot.yml configuration file for version updates (#1862) * Create dependabot.yml configuration file * Update dependabot.yml Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * add target-branch Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update dependabot.yml Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * limit dependabot to just dependency folder Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update test_requirements.txt Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update MANIFEST.in Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * fix e2e Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update continue_config.yml Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update requirements.txt Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Update requirements.txt Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * fix link Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * revert Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * Delete requirements.txt Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update dependabot config (#1928) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update robots.txt (#1929) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * fix broken link (#1950) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update dependabot.yml config (#1938) * Update dependabot.yml Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * pin jupyterlab_services to requirments Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> * lint Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update setup.py Jinja2 dependencies (#1954) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update pip-tools requirement from ~=6.5 to ~=6.9 in /dependency (#1957) Updates the requirements on [pip-tools](https://github.com/jazzband/pip-tools) to permit the latest version. - [Release notes](https://github.com/jazzband/pip-tools/releases) - [Changelog](https://github.com/jazzband/pip-tools/blob/master/CHANGELOG.md) - [Commits](jazzband/pip-tools@6.5.0...6.9.0) --- updated-dependencies: - dependency-name: pip-tools dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update toposort requirement from ~=1.5 to ~=1.7 in /dependency (#1956) Updates the requirements on [toposort]() to permit the latest version. --- updated-dependencies: - dependency-name: toposort dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sajid Alam <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add deprecation warning to package_name argument in session create() (#1953) Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Remove redundant `resolve_load_version` call (#1911) * remove a redundant function call Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Remove redundant resolove_load_version & fix test Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Fix HoloviewWriter tests with more specific error message pattern & Lint Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> * Rename tests Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Make docstring in test starter match real starters (#1916) Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Try to fix formatting error Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Specify pickle import Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> Signed-off-by: jstammers <jimmy.stammers@cgastrategy.com> Signed-off-by: Nok <nok_lam_chan@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Signed-off-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: ankatiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> Signed-off-by: yash6318 <yash.agrawal.cse21@iitbhu.ac.in> Signed-off-by: Carla Vieira <carlaprv@hotmail.com> Signed-off-by: dinotuku <kuan.tung@epfl.ch> Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Nok <mediumnok@gmail.com> Co-authored-by: Jimmy Stammers <jimmy.stammers@gmail.com> Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Co-authored-by: Yetunde Dada <43755008+yetudada@users.noreply.github.com> Co-authored-by: Jannic <37243923+jmholzer@users.noreply.github.com> Co-authored-by: Yash Agrawal <96697569+yash6318@users.noreply.github.com> Co-authored-by: Deepyaman Datta <deepyaman.datta@utexas.edu> Co-authored-by: Carla Vieira <carlaprv@hotmail.com> Co-authored-by: Kuan Tung <kuan.tung@epfl.ch> Co-authored-by: Sajid Alam <90610031+SajidAlamQB@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Merel Theisen <merel.theisen@quantumblack.com>

Add documentation for linting tools

87b98b2

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

ankatiyar requested a review from yetudada as a code owner October 5, 2022 15:56

ankatiyar changed the title ~~Add documentation for linting tools~~ Document how users can use linting tools instead of kedro lint Oct 5, 2022

ankatiyar requested review from jmholzer, merelcht and noklam October 5, 2022 15:58

noklam reviewed Oct 6, 2022

View reviewed changes

merelcht reviewed Oct 6, 2022

View reviewed changes

jmholzer reviewed Oct 6, 2022

View reviewed changes

ankatiyar commented Oct 7, 2022

View reviewed changes

ankatiyar added 2 commits October 7, 2022 11:22

Revert changes to commands_reference.md

700ede4

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

Update linting docs with suggestions

6c2271d

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

jmholzer mentioned this pull request Oct 7, 2022

Add deprecation warnings in the docs for commands being removed in 0.19.0 #1912

Merged

5 tasks

SajidAlamQB reviewed Oct 10, 2022

View reviewed changes

merelcht approved these changes Oct 10, 2022

View reviewed changes

Update linting doc

969c6dc

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

SajidAlamQB approved these changes Oct 10, 2022

View reviewed changes

Merge branch 'main' into docs/document-how-users-can-use-linting-tools

cad90cc

ankatiyar merged commit 927f26e into main Oct 10, 2022

ankatiyar deleted the docs/document-how-users-can-use-linting-tools branch October 10, 2022 14:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document how users can use linting tools instead of `kedro lint` #1904

Document how users can use linting tools instead of `kedro lint` #1904

ankatiyar commented Oct 5, 2022 •

edited by gitpod-io bot

Loading

noklam left a comment

ankatiyar commented Oct 6, 2022 •

edited

Loading

merelcht left a comment

merelcht Oct 6, 2022

ankatiyar Oct 7, 2022

jmholzer left a comment •

edited

Loading

jmholzer Oct 6, 2022 •

edited

Loading

ankatiyar Oct 7, 2022

jmholzer Oct 6, 2022 •

edited

Loading

jmholzer Oct 6, 2022

ankatiyar Oct 7, 2022

ankatiyar Oct 7, 2022

SajidAlamQB Oct 10, 2022

ankatiyar Oct 10, 2022

SajidAlamQB Oct 10, 2022

ankatiyar Oct 10, 2022

merelcht left a comment

merelcht Oct 10, 2022

ankatiyar Oct 10, 2022

SajidAlamQB left a comment

	- `black` is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. Read the full documentation [here](https://black.readthedocs.io/en/stable/).
	- `black` is a [PEP 8](https://peps.python.org/pep-0008/) compliant opinionated Python code formatter. [You can read more in the black documentation](https://black.readthedocs.io/en/stable/).

	Lint, or a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs.
	Linting tools are used to improve the quality of your code by checking for errors and making sure it meets a stylistic standard before it is run.


		## Automating linting with `pre-commit` hooks

		You can also automate linting by using [`pre-commit`](https://github.com/pre-commit/pre-commit) hooks.

	You can also automate linting by using [`pre-commit`](https://github.com/pre-commit/pre-commit) hooks.
	[`pre-commit`](https://github.com/pre-commit/pre-commit) hooks can be used to automate linting.

	- `isort` is a Python library used to sort imports alphabetically, and automatically separated into sections and by
	- `isort` is a Python library used to sort imports alphabetically and automatically separate them into sections and by

Document how users can use linting tools instead of kedro lint #1904

Document how users can use linting tools instead of kedro lint #1904

Conversation

ankatiyar commented Oct 5, 2022 • edited by gitpod-io bot Loading

Description

Development notes

Checklist

noklam left a comment

Choose a reason for hiding this comment

ankatiyar commented Oct 6, 2022 • edited Loading

merelcht left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmholzer left a comment • edited Loading

Choose a reason for hiding this comment

jmholzer Oct 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmholzer Oct 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merelcht left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SajidAlamQB left a comment

Choose a reason for hiding this comment

Document how users can use linting tools instead of `kedro lint` #1904

Document how users can use linting tools instead of `kedro lint` #1904

ankatiyar commented Oct 5, 2022 •

edited by gitpod-io bot

Loading

ankatiyar commented Oct 6, 2022 •

edited

Loading

jmholzer left a comment •

edited

Loading

jmholzer Oct 6, 2022 •

edited

Loading

jmholzer Oct 6, 2022 •

edited

Loading