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

Update linting page to add flake8 configuration (and make some minor improvements) #2517

Merged
merged 6 commits into from Apr 15, 2023

Conversation

stichbury
Copy link
Contributor

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Created in response to #2473 to add a small amount of information about configuration.

Also added a few minor tweaks to clarify the purpose of formatting/linting and the differences between them.

Development notes

Changed one file, linted, rebuilt and inspected.

I'd value input on whether there's more configuration information I could add here or if I've put the most useful information in (to mirror what we do for the starters). I notice that we have slightly different config for flake8 for the Kedro project itself...would it be useful to add any other commonly used settings?

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: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Apr 13, 2023
@stichbury stichbury self-assigned this Apr 13, 2023
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a neat improvement over what we have now, but left a few comments, mainly food for thought (not necessarily for this PR)

docs/source/development/linting.md Show resolved Hide resolved
docs/source/development/linting.md Show resolved Hide resolved
docs/source/development/linting.md Show resolved Hide resolved
Copy link
Contributor

@jmholzer jmholzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is great work. These docs will be in a much better state after this merge.

docs/source/development/linting.md Outdated Show resolved Hide resolved
docs/source/development/linting.md Show resolved Hide resolved
docs/source/development/linting.md Show resolved Hide resolved
@stichbury stichbury changed the title Update linting page to add flake8 configuration (and make some minor improvements_ Update linting page to add flake8 configuration (and make some minor improvements) Apr 14, 2023
@stichbury stichbury merged commit ab706a2 into main Apr 15, 2023
10 checks passed
@stichbury stichbury deleted the 2473-add-flake8-config branch April 15, 2023 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants