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

Start applying ruff rules to notebooks (ruff 0.6+) #2115

Draft
wants to merge 10 commits into
base: v3
Choose a base branch
from

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Aug 24, 2024

Jupyter notebooks are now linted and formatted by default

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

F811 Redefinition of unused
W293 Blank line contains whitespace
I001 Import block is un-sorted or un-formatted
UP031 Use format specifiers instead of percent format
UP032 Use f-string instead of `format` call
UP033 Use `@functools.cache` instead of `@functools.lru_cache(maxsize=None)`
RUF010 Use explicit conversion flag
E402 Module level import not at top of cell
@jhamman
Copy link
Member

jhamman commented Sep 13, 2024

I'm fine merging this in as is @DimitriPapadopoulos. We may also consider removing these notebooks from the repo as many of them are referencing data that we don't have access to.

@jhamman jhamman added this to the After 3.0.0 milestone Sep 13, 2024
@jhamman jhamman added the V3 Related to compatibility with V3 spec label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V3 Related to compatibility with V3 spec
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants