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 docs to remove flake8, isort mentions and add ruff #502

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

melissawm
Copy link
Member

References and relevant issues

Partially addresses #377.

Mentions to setup.cfg remain in the plugin docs which need to be updated separately.

Description

Updates mentions of flake8 and isort by ruff.

Also removes some explicit mentions of ignore rules since these get out of date quickly and can be checked directly in the pyproject.toml file.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 22, 2024
Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @melissawm

@DragaDoncila DragaDoncila added this to the 0.5.5 milestone Oct 23, 2024
Comment on lines 26 to 27
* [black](https://github.com/psf/black)
Forces code to follow specific style, indentations, etc...
Copy link
Contributor

Choose a reason for hiding this comment

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

We are using ruff-format, not black now.
It is slimier to black, but not equivalent.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah right -I only see one rule though

https://github.com/napari/napari/blob/b9dc8dca1e1afa7567586e7ffa7a36cc7cd9fb6f/pyproject.toml#L245

so I'll again just point people to the pyproject.toml in case there are future updates.

Copy link
Contributor

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

@melissawm If you scroll down from your link, ruff is performing all of the task that you had in the original text since it is a drop-in replacement for these tools. Perhaps link out to ruff docs: https://docs.astral.sh/ruff/linter/#the-ruff-linter

Comment on lines 26 to 27
* [black](https://github.com/psf/black)
Forces code to follow specific style, indentations, etc...

Choose a reason for hiding this comment

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

@melissawm If you scroll down from your link, ruff is performing all of the task that you had in the original text since it is a drop-in replacement for these tools. Perhaps link out to ruff docs: https://docs.astral.sh/ruff/linter/#the-ruff-linter

@@ -25,12 +25,6 @@ These _check_ your code.
These _auto-modify_ your code.
* [black](https://github.com/psf/black)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* [black](https://github.com/psf/black)
* [ruff-formater](https://docs.astral.sh/ruff/formatter/)

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Nov 1, 2024

I popped the ready to merge because there is one more place where black needs to be replaced with ruff-formatter.
Otherwise, looks great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants