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

build: enable ruff-specific rules in ruff #642

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

DimitriPapadopoulos
Copy link
Contributor

No description provided.

@coveralls
Copy link

coveralls commented Jan 13, 2024

Coverage Status

coverage: 99.822%. remained the same
when pulling ddce1b0 on DimitriPapadopoulos:RUF
into 3cb3a20 on adrienverge:master.

@DimitriPapadopoulos DimitriPapadopoulos changed the title build: enable ruff-specififc rules in ruff build: enable ruff-specific rules in ruff Jan 13, 2024
Copy link
Owner

@adrienverge adrienverge left a comment

Choose a reason for hiding this comment

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

Review would be easier with a small explanation in the commit message 🙂 For example it took me 2 minutes to find https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf and understand what this change does. (This remark applies to all pull requests.)

Although the Unused noqa directive is cool and useful, I don't like the others (see my inline comment). They look like over-linting. I propose to only add RUF100.

@@ -70,7 +70,7 @@ def setUpModule():
env_vars_that_could_interfere = (
'YAMLLINT_CONFIG_FILE',
'XDG_CONFIG_HOME',
# These variables are used to determine where the user’s home
Copy link
Owner

Choose a reason for hiding this comment

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

I thought was a valid, and even "more correct":

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did add an explanation in the commit message, perhaps it is not clear enough:

RUF003 Comment contains ambiguous `’` (RIGHT SINGLE QUOTATION MARK). Did you mean ``` (GRAVE ACCENT)?

Doesn't make much sense, however let's be consistent and use ' apostrophes, as in all other code comments.

Both are somehow correct. I decided to address this specific occurrence of the warning, which I agree might not make sense in other contexts, because:

  • you use ' everywhere else, is used only for this specific apostrophe,

  • the Python documentation does not use in the source of the documentation, ' is changed into when rendering the documentation to HTML and other formats:

    python/cpython/Doc/library/os.path.rst
    Lines 157 to 160 in e649515

    .. function:: expanduser(path)
    
       On Unix and Windows, return the argument with an initial component of ``~`` or
       ``~user`` replaced by that *user*'s home directory.

Copy link
Owner

Choose a reason for hiding this comment

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

I did add an explanation in the commit message, perhaps it is not clear enough

Sorry, my bad, I missed it! (I'm used to commit messages copied-pasted in the pull request message, but I shouldn't rely on that.)

Both apostrophes types are correct, but is "more" correct, typographically speaking. Some years ago using such Unicode characters could cause problems, but nowadays there are no reasons not to use the "right" characters (and emojis, if we wanted to...)
The fact that we use another "less right" apostrophe ' at many other places is not perfectly satisfying, I agree, but it's not a good reason to suppress the correct one.

  • the Python documentation does not use in the source of the documentation, ' is changed into when rendering the documentation

I didn't know, that's nice 👍
About yamllint, comments in Python code are not meant to be post-processed, so we can use right away.

OK for you to keep ?

RUF003 Comment contains ambiguous `’` (RIGHT SINGLE QUOTATION MARK).
       Did you mean ``` (GRAVE ACCENT)?

Doesn't make much sense, however let's be consistent and use `'`
apostrophes, as in all other code comments.
@DimitriPapadopoulos
Copy link
Contributor Author

DimitriPapadopoulos commented Jan 20, 2024

Removed all RUF rules but RUF100.

@adrienverge
Copy link
Owner

Removed all RUF rules but RUF100.

Thanks!

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

Successfully merging this pull request may close these issues.

None yet

3 participants