gh-248: a few fixes for ignored and recommended ruff rules #360
Conversation
pyproject.toml
Outdated
| @@ -160,11 +156,10 @@ lint.per-file-ignores = {"__init__.py" = [ | |||
| "ANN201", # TODO: issing-return-type-undocumented-public-function | |||
| "ANN202", # TODO: missing-return-type-private-function | |||
| "D100", # undocumented-public-module | |||
| "D103", # TODO: undocumented-public-function | |||
There was a problem hiding this comment.
I think it should be okay to not have docstrings in the test functions
There was a problem hiding this comment.
I do think it's something we should work towards
| @@ -121,12 +121,8 @@ lint.ignore = [ | |||
| "ANN002", # TODO: missing-type-args | |||
| "ANN003", # TODO: missing-type-kwargs | |||
| "ANN201", # TODO: missing-return-type-undocumented-public-function | |||
| "COM812", # missing-trailing-comma (ruff-format recommended) | |||
There was a problem hiding this comment.
You have to leave this one in, that is why I didn't write TODO... In fact, there are more than I thought - just found the docs https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
| "D203", # one-blank-line-before-class | ||
| "D212", # blank-line-before-class | ||
| "ERA001", # TODO: commented-out-code | ||
| "ISC001", # single-line-implicit-string-concatenation (ruff-format recommended) |
There was a problem hiding this comment.
You have to leave this one in, that is why I didn't write TODO... In fact, there are more than I thought - just found the docs https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
There was a problem hiding this comment.
Ah, I thought the recommendation meant adding it at some point. My bad!
There was a problem hiding this comment.
Could you make an issue to look into these conflicting rules?
pyproject.toml
Outdated
| @@ -160,11 +156,10 @@ lint.per-file-ignores = {"__init__.py" = [ | |||
| "ANN201", # TODO: issing-return-type-undocumented-public-function | |||
| "ANN202", # TODO: missing-return-type-private-function | |||
| "D100", # undocumented-public-module | |||
| "D103", # TODO: undocumented-public-function | |||
There was a problem hiding this comment.
I do think it's something we should work towards
examples/1-basic/photoz.ipynb
Outdated
There was a problem hiding this comment.
Can we add a random seed to default_rng?
examples/1-basic/photoz.ipynb
Outdated
There was a problem hiding this comment.
If we are introducing a new concept into the example (creating a RNG), then it should ideally happen explicitly and somewhere near the top.
examples/1-basic/lensing.ipynb
Outdated
There was a problem hiding this comment.
There are comments like this one in all of the examples, and they no longer make sense because now the user does not have to import N different modules.
Maybe we could comment something like
# almost all GLASS functionality is available from the `glass` namespace
Saransh-cpp
changed the title
Saransh-cpp
force-pushed
the
saransh/ruff-fixes
branch
from
c4698e6 to
ca4bb53
Compare
Saransh-cpp
force-pushed
the
saransh/ruff-fixes
branch
from
ca4bb53 to
70ed216
Compare
|
Thanks for the reviews! This should be better now. |
Fixed:
Refs: #248