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

bpo-35563: Add reference links to warnings.rst #11289

Merged
merged 2 commits into from May 20, 2019

Conversation

csabella
Copy link
Contributor

@csabella csabella commented Dec 22, 2018

Some text in warnings.rst refers to other sections, so this will add links for those.

https://bugs.python.org/issue35563

@@ -192,7 +192,7 @@ colons::

The meaning of each of these fields is as described in :ref:`warning-filter`.
When listing multiple filters on a single line (as for
:envvar:`PYTHONWARNINGS`), the individual filters are separated by commas,and
:envvar:`PYTHONWARNINGS`), the individual filters are separated by commas and
Copy link
Member

@serhiy-storchaka serhiy-storchaka Dec 22, 2018

Choose a reason for hiding this comment

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

Is not a comma needed here? "[...] filters are separated [...] , and [...] filters [...] take precedence [...] , and [...] filters take precedence [...]"

Copy link
Contributor Author

@csabella csabella Dec 22, 2018

Choose a reason for hiding this comment

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

The second filters take precedence that you are quoting is inside the parentheses, so it's not part of the and. Only the first two verbs that you highlighted are part of the statement.

I did have to read that sentence a few times to understand it, but I didn't want to change any wording in this PR.

Copy link
Member

@serhiy-storchaka serhiy-storchaka Dec 22, 2018

Choose a reason for hiding this comment

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

You are right. I missed parenthesis.

But should not two clauses "filters are separated" and "filters take precedence" be separated by a comma? I am not English expert at all, so sorry for disturbs.

Copy link
Contributor Author

@csabella csabella Dec 22, 2018

Choose a reason for hiding this comment

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

I'm glad you're asking. :-) In English, sentences with 3 or more verbs should use a comma, but when there are only 2 verbs, there shouldn't be a comma. Look at the Comma Between Two Verbs in a Compound Predicate section.

I know there are other instances in the doc where two verbs have a comma before the and. I fixed this one because there wasn't a space and the correct fix wasn't to add a space, but rather to change the comma into a space. If you think it's not much code churn, I can fix the other 3 instances on this page. I don't think it's a big deal to have the comma, but it's technically not correct.

Doc/library/warnings.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants