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.

Sign up for GitHub

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

Jump to bottom

build: enable ruff-specific rules in ruff #642

Closed
wants to merge 2 commits into from
Closed

build: enable ruff-specific rules in ruff #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e72595
style: silence ruff-specific warning
DimitriPapadopoulos Jan 13, 2024
ddce1b0
build: enable some ruff-specific rules in ruff
DimitriPapadopoulos Jan 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[lint]
extend-select = ["B", "I", "PGH", "TRY", "UP"]
extend-select = ["B", "I", "PGH", "RUF100", "TRY", "UP"]
ignore = ["TRY003"]

[lint.isort]
Expand Down
2 changes: 1 addition & 1 deletion tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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

@DimitriPapadopoulos DimitriPapadopoulos Jan 20, 2024 •
edited
Loading

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 ’?

# These variables are used to determine where the user's home
# directory is. See
# https://docs.python.org/3/library/os.path.html#os.path.expanduser
'HOME',
Expand Down
Loading