-
Notifications
You must be signed in to change notification settings - Fork 413
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
chore: remove references to black from the project #2674
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fpgmaas
requested review from
MrPowers,
wjones127,
rtyler,
fvaleye,
roeap and
ion-elgreco
as code owners
July 16, 2024 15:16
rtyler
previously approved these changes
Jul 16, 2024
I believe CI/CD is failing due to this issue. Merging this PR will solve it for now. |
fpgmaas
force-pushed
the
chore/remove-black
branch
from
July 16, 2024 19:23
b7ab84e
to
9c55e7c
Compare
rtyler
pushed a commit
that referenced
this pull request
Jul 18, 2024
…ipeline (#2679) Currently, `ruff` and `mypy` have their latest versions installed in the CI pipeline, while locally they are fixed to a specific version. This can cause issues, see #2678. This PR proposes to fix them to their specific version in the pipeline. The alternative I could think of was installing the virtual environment with `make develop`, but that takes between 4 and 5 minutes, which might be considered a bit too long to wait on linting results. This PR will have conflicts with #2674, so I'll need to rebase one of these PR's once the other is merged. # Related Issue(s) - closes [#106](#2678)
rtyler
approved these changes
Jul 18, 2024
auto-merge was automatically disabled
July 18, 2024 10:42
Rebase failed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There are a few mentions of
black
in the project, but they seem inconsistent;.github/workflows/docs.yml
, we use black to validate the formatting of Python code in the docs. However, there is no set-up or instructions to format code locally. Of course this is not a big issue; fixing the formatting is trivial when this gives an error by installingblack
..github/workflows/python_build.yml
black
seems to be installed but unused.black
inpython/pyproject.toml
, even though the formatter for the project isruff
.This PR aims to solve these inconsistencies:
black
listed above.ruff
as a formatter for thedocs
to be consistent with thepython
directory.Makefile
to thedocs
directory, with aformat
and acheck
command.Considered alternative
I also considered adding the
make
commands topython/Makefile
, similar to thebuild-docs
command:However, this solution has the disadvantage that we need to either install the complete virtual environment in the
docs.yml
workflow, or hardcode the version ofruff
there, e.g.