-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
PEP 685: Minor wording changes #2448
Conversation
For clarity, these changes were discussed on PEP's discussion thread. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor comment to consider, but otherwise LGTM
@@ -59,7 +59,7 @@ via:: | |||
re.sub(r'[^A-Za-z0-9-.]+', '_', name).lower() | |||
|
|||
The use of an underscore/``_`` differs from PEP 503's use of a hyphen/``-``, | |||
and it also normalizes characters outside of those allowed by :pep`508`. | |||
and it also normalizes characters outside of those allowed by :pep:`508`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, I didn't catch this; surprised it didn't result in a Sphinx-level syntax error. I could have the linters check for cases like this, but I'm not sure if its common or general enough to justify.
Tools SHOULD warn users when an invalid extra name is read and SHOULD ignore | ||
the name to avoid ambiguity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tools SHOULD warn users when an invalid extra name is read and SHOULD ignore | |
the name to avoid ambiguity. | |
Tools SHOULD warn users when an invalid extra name is read and SHOULD ignore | |
the extra to avoid ambiguity. |
Maybe I'm splitting hairs, but for clarity's sake, wouldn't it be the extra that is ignored, (i.e. not installed), not just the name used for it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see there's a significant difference, but I'm not sufficiently bothered that I'll argue either way. Both "extra" and "name" clearly (IMO) refer back to the term "extra name".
Note that this sentence doesn't necessarily refer to installers - the tool might be an analysis utility that's reporting what extras are present in a set of projects, for example.
No description provided.