Skip to content

Tidyup - #19

Open
avadean wants to merge 8 commits into
Plasdom:mainfrom
PlasmaFAIR:tidyup
Open

Tidyup#19
avadean wants to merge 8 commits into
Plasdom:mainfrom
PlasmaFAIR:tidyup

Conversation

@avadean

@avadean avadean commented Feb 3, 2026

Copy link
Copy Markdown
Collaborator
  • Tidy ups of code and tests via Ruff format & check
  • Removed large chunks of commented-out code
  • Git blame ignore revs for large tidy ups
  • Add "lint" optional dependency
  • Add lint selection and ignore rules
  • Add lint workflow
  • Move all tests to one place

!! No actual code changes !!

Fixes issues #8, #9 and #13

@avadean
avadean requested a review from Plasdom February 3, 2026 17:55
@Plasdom

Plasdom commented Feb 6, 2026

Copy link
Copy Markdown
Owner

This all looks great. Could you please just explain what the linting workflow does/how it's used? Is this something that runs automatically on new commits?

avadean added 8 commits May 28, 2026 16:48
Format using the Ruff linter

Organise import blocks

Tidy up of miscellaneous Ruff linter check errors.

Fix Yoda conditions

Simplify if/else and return statements

Remove unnecessary use of list on set sorts

Reorder type hints

Remove the unnecessary assignment of variables

Replace use of open with Path.open for file handling

Remove and ignore use of ambiguous variable names

Remove unused assignment of variables

Convert unused variables to underscore format

Convert format calls on strings to f-strings

Remove use of * imports and remove unused imports

Remove use of * imports and update __all__
@avadean

avadean commented May 28, 2026

Copy link
Copy Markdown
Collaborator Author

This all looks great. Could you please just explain what the linting workflow does/how it's used? Is this something that runs automatically on new commits?

@Plasdom

The linter workflow will be ran when a contributor submits a Pull Request. It will run both the format and check commands - the former formats the code neatly, and the latter catches any bad code "smells".

The workflow will run the commands in a virtual machine, not on the actual code of the repository (i.e it won't actually change any code). It will simply check for a non-zero exit code (i.e a problem found) and if one is found, the PR will be marked with a red cross. This would just mean the contributor should go and run the commands themselves, resolve any issues, and push again and hope for them to pass and give a green tick. :)

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.

2 participants