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

feat(all): add ruff as default linter and additional clean up #922

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

spencer-tb
Copy link
Collaborator

@spencer-tb spencer-tb commented Oct 29, 2024

πŸ—’οΈ Description

Pre-dominantly adds ruff as our default linter to replace flake8, black & isort. Extra clean-up items are mentioned below.

πŸ§‘β€πŸ’» .vscode

The settings.recommended.json has be split into 2 files:

  • settings.json: locked config that users of the repo MUST use.
  • .settings.local.recommended.json: settings that users can change, for example python testing extension related.

πŸ’₯ Removal of tf

It seems relevant for us to deperate tf now. Most repo users are familiar with the uv fill etc approach now.

πŸ“œ Ruff Related Docstring Changes

A large portion of the diff comes from changes to the python docstrings, via:

One-line docstring should fit on one lineRuff D200
First line of docstring should be in imperative mood: "Handles all fill CLI flag pre-processing."Ruff D401
First line should end with a periodRuff D400

βœ… Fixes to noqa: and TODO:

Those that can be fixed now are updated!

Screenshot 2024-10-30 at 14 51 58

With a new linter its seems logical to enforce python docstring standards from now on. Note the warnings appear within VSCode and additionally when running tox.

πŸ”— Related Issues

#811

βœ… Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.

@spencer-tb spencer-tb added the type:feat type: Feature label Oct 29, 2024
@spencer-tb spencer-tb changed the title feat(all feat(all): add ruff as the default linter for EEST Oct 29, 2024
@spencer-tb spencer-tb changed the title feat(all): add ruff as the default linter for EEST feat(all): add ruff as default linter and additional clean up Oct 29, 2024
@spencer-tb spencer-tb force-pushed the dog-goes-ruffruffruff branch 3 times, most recently from 53288a9 to cfd6b11 Compare October 30, 2024 08:26
@marioevz
Copy link
Member

marioevz commented Nov 1, 2024

@spencer-tb could we rebase this to main please? I think it would make it easier to spot issues in the CI if we include the fixes from #905

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feat type: Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants