[issue34682] Typo reports on docs@

[Cheryl Sabella]

Cheryl Sabella  added the comment:

Thank you @divyag for the patch and thank you @matrixise for the backport!

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Julien Palard]

Julien Palard  added the comment:


New changeset 074d7c44a474680122ed869bb6be89c1f4f18f12 by Julien Palard 
(Stéphane Wirtel) in branch '3.7':
[3.7] bpo-34682: Wording and grammatical changes to the 
doc(https://docs.python.org/3) (GH-13120) (GH-13281)
https://github.com/python/cpython/commit/074d7c44a474680122ed869bb6be89c1f4f18f12


--
nosy: +mdk

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Stéphane Wirtel]

Change by Stéphane Wirtel :


--
pull_requests: +13187

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[miss-islington]

miss-islington  added the comment:


New changeset 778a9107586e29421af3a08209cf0b557c1fe5bc by Miss Islington (bot) 
(divyag9) in branch 'master':
bpo-34682: Wording and grammatical changes to the 
doc(https://docs.python.org/3) (GH-13120)
https://github.com/python/cpython/commit/778a9107586e29421af3a08209cf0b557c1fe5bc


--
nosy: +miss-islington

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[miss-islington]

Change by miss-islington :


--
pull_requests: +13185

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Divya Gorantla]

Change by Divya Gorantla :


--
keywords: +patch
pull_requests: +13033
stage: needs patch -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Divya Gorantla]

Divya Gorantla  added the comment:

I'll be working on this issue

--
nosy: +divyag

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Cheryl Sabella]

Cheryl Sabella  added the comment:

This is a good first issue even though there are multiple changes.  Some of the 
changes are no longer needed since the docs have changed, so please check the 
current comments and the current docs to see what still needs to be applied.

--
keywords: +easy
nosy: +cheryl.sabella
type:  -> enhancement
versions:  -Python 2.7, Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[ZooDSS]

ZooDSS  added the comment:

Found new one.

https://docs.python.org/3/reference/lexical_analysis.html#comments
"Comments are ignored by the syntax; they are not tokens." - I honestly think, 
that this is misleading, by the fact that we have next words.

https://docs.python.org/3/library/token.html#token.COMMENT
"Token value used to indicate a comment." - this means, that system mentions 
the comment as a token, but still ch.2 of LR says backwards. May be I am wrong. 
Correct me, please.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[ZooDSS]

ZooDSS  added the comment:

Wanted to add a little bit more, but didn't know where to, so here it goes.

https://docs.python.org/3/reference/expressions.html#membership-test-operations

"The operator not in is defined to have the inverse true value of in." may be 
better to use "... the inverse truth value of in." as it is used in the next 
section, for identity comparisons explanation:

"x is not y yields the inverse truth value."


https://docs.python.org/3/reference/expressions.html#is-not

In this section "object identity" is used two times. May be better to say 
"object's identity", as identity is a part of an object. Object has identity.

"...test for object identity" - here.
"Object identity is determined..." - and here.

--
nosy: +ZooDSS

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Eric V. Smith]

Eric V. Smith  added the comment:

Agreed with @geoffreyspear: "means" is okay, the rest of the changes look good.

--
nosy: +eric.smith

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Geoffrey Spear]

Geoffrey Spear  added the comment:

"Means" is perfectly acceptable to use as a singular form: 
http://grammarist.com/usage/means/ (the rest of these all look like legitimate 
typos)

--
nosy: +geoffreyspear

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34682] Typo reports on docs@

[Zachary Ware]

New submission from Zachary Ware :

>From ZooDSS (Никита Люшненко) on docs@:

https://mail.python.org/pipermail/docs/2018-September/037223.html :
"""
https://docs.python.org/3/reference/datamodel.html#metaclass-example - 
"uses an collections.OrderedDict to remember" when it is better to use 
"uses a collections.OrderedDict to remember"

https://docs.python.org/3/reference/executionmodel.html#exceptions
"Exceptions are a means" - Is it correct to use "a" here? "means" means a lot 
of them. "a" means one.

"In either case, it prints a stack backtrace" - most of the time in Python 
documentation term "traceback" is used instead of "backtrace". It may mislead 
newcomers, so they will think, that this is potentially a new term.

https://docs.python.org/3/reference/expressions.html#yield-expressions
"Due to their side effects on the containing scope, yield expressions are not 
permitted as part of the implicitly defined scopes used to implement 
comprehensions and generator expressions (in Python 3.7, such expressions emit 
DeprecationWarning when compiled, in Python 3.8+ they will emit SyntaxError).." 
- two periods in the end of the sentence.

https://docs.python.org/3/reference/expressions.html#yield-expressions
"...or automatically when the sub-iterator is a generator (by returning a value 
from the sub-generator)." - inconsistent use of "sub-iterator" term. Previously 
subiterator was referenced several times as "subiterator" not "sub-iterator".

If i understood something wrong, then i am sorry.
"""

https://mail.python.org/pipermail/docs/2018-September/037224.html :
"""
https://docs.python.org/3/reference/expressions.html#yield-expressions

Term "sub-generator" is used in PEP 280 without dash ("-") symbol - 
"subgenerator". At the same time it is used as "sub-generator" 2 times on this 
page:

"generator (by returning a value from the sub-generator)." - here.

"The proposal to introduce the yield_from syntax, making delegation to 
sub-generators easy." - and here.
"""

https://mail.python.org/pipermail/docs/2018-September/037237.html :
"""
https://docs.python.org/3/reference/expressions.html#asynchronous-generator-functions
"function as a asynchronous generator function." - it's better to say "function 
as an asynchronous generator function."

https://docs.python.org/3/reference/expressions.html#agen.__anext__
"When an asynchronous generator function is resumed with a __anext__() method" 
- may be better "...function is resumed with an __anext__() method".

"the awaitable instead raises an StopAsyncIteration exception" - at the same 
time here may be better to use "the awaitable instead raises a 
StopAsyncIteration exception".

https://docs.python.org/3/reference/expressions.html#agen.athrow
"an StopAsyncIteration exception is raised" - here is the same situation as 
previously. "a" instead of "an" may be better.

Here goes very special case, and if i am wrong you can laugh on me as much as 
you wish! =)

https://docs.python.org/3/reference/expressions.html#parenthesized-forms
"Since tuples are immutable, the rules for literals apply" - Tuples are 
immutable, but not literals. So may be "the same rules as for literals apply" 
is better? Or does it apply exactly those rules, that apply for literals? "()" 
- this is a literal, that yelds an empty tuple. But this doesn't connect, or i 
am wrong? If i am - then i am very sorry.

Again, if i mistook something - i am sorry. Thanks for the good work. This is 
the best documentation i've ever seen.
"""

--
assignee: docs@python
components: Documentation
messages: 325362
nosy: docs@python, zach.ware
priority: normal
severity: normal
stage: needs patch
status: open
title: Typo reports on docs@
versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com