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

Add RUFF linting/formatting #143

Merged
merged 40 commits into from
Dec 15, 2023
Merged

Conversation

paulf81
Copy link
Collaborator

@paulf81 paulf81 commented Dec 6, 2023

Add RUFF linting/formatting

This pull request will add RUFF as the linting/formatter for FLASC. This pull request will replace #61 as that one has gotten a bit stale. RUFF linting and formatting regulates the style of the code to confirm with something like the BLACK standard (https://github.com/psf/black). It is also the lint/formatter used for FLORIS

Feature or improvement description

  • Adds pyproject.toml which contains RUFF settings
  • Applied ruff linting and formatting to each python and jupyter notebook file
  • Added ruff pre-commit
  • Updated documentation

closes Issue #146

Other notes

Almost every file is touched by this, but I confirmed all tests pass and just picking some examples at random shows no issue.

Still to go:

  • Need to decide if ok to allow reformating of init files
  • Implement remaining manual corrections (mostly over-long comment lines)

@paulf81 paulf81 added the enhancement An improvement of an existing feature label Dec 6, 2023
@paulf81 paulf81 requested a review from misi9170 December 6, 2023 20:14
@paulf81 paulf81 self-assigned this Dec 6, 2023
@paulf81 paulf81 mentioned this pull request Dec 6, 2023
@paulf81
Copy link
Collaborator Author

paulf81 commented Dec 8, 2023

@misi9170 I think this is almost ready, the main thing left I think is figure out a way to quickly churn through the long line errors that I can't seem to fix automatically, there's unfortunately a lot of them...

@paulf81 paulf81 marked this pull request as ready for review December 12, 2023 21:18
@paulf81
Copy link
Collaborator Author

paulf81 commented Dec 12, 2023

ok @misi9170 this is finally ready for review, but no rush, thanks!

@paulf81 paulf81 mentioned this pull request Dec 14, 2023
7 tasks
@paulf81
Copy link
Collaborator Author

paulf81 commented Dec 15, 2023

Going to merge now to clean up some other incoming requests,

@paulf81 paulf81 merged commit 98b8c2b into NREL:develop Dec 15, 2023
3 checks passed
@paulf81 paulf81 deleted the feature/add_ruff_2 branch December 15, 2023 20:24
@misi9170 misi9170 mentioned this pull request Apr 10, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant