Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(15)

#29247: Document return value of epoll.poll

Can't Edit
Can't Publish+Mail
Start Review
Created:
2 years, 12 months ago by njs
Modified:
2 years, 12 months ago
Reviewers:
marco.buttu, berker.peksag
CC:
njs, docs_python.org, berkerpeksag, marco.buttu, Winterflower, csabella
Visibility:
Public.

Patch Set 1 #

Total comments: 2
Unified diffs Side-by-side diffs Delta from patch set Stats Patch
Doc/library/select.rst View 2 chunks +30 lines, -29 lines 2 comments Download

Messages

Total messages: 5
marco.buttu
https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst File Doc/library/select.rst (right): https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst#newcode346 Doc/library/select.rst:346: Wait for events. *timeout* in seconds (float) Return a ...
2 years, 12 months ago #1
marco.buttu
https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst File Doc/library/select.rst (right): https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst#newcode346 Doc/library/select.rst:346: Wait for events. *timeout* in seconds (float) Return a ...
2 years, 12 months ago #2
berkerpeksag
On 2017/01/30 12:39:39, marco.buttu wrote: > https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst > File Doc/library/select.rst (right): > > https://bugs.python.org/review/29247/diff/19866/Doc/library/select.rst#newcode346 > ...
2 years, 12 months ago #3
marco.buttu
On 2017/01/30 13:13:36, berkerpeksag wrote: > > I agree that the current wording is not ...
2 years, 12 months ago #4
berkerpeksag
2 years, 12 months ago #5
On 2017/01/30 13:55:49, marco.buttu wrote:
> On 2017/01/30 13:13:36, berkerpeksag wrote:
> > 
> > I agree that the current wording is not ideal. What about
> > 
> >    If *timeout* is a float then the call waits for at most that many
seconds.
> >    If *timeout* is -1 (the default) then it will wait for an unlimited
period.
> 
> The patch you attached is fine to me. I was just pointing out that there is a
> missing dot after "(float)". If in addition you integrate with your last
> sentence (If *timeout* is -1 (the default) then it will wait for an unlimited
> period.), maybe it would also be better.

You probably right about the typo (I haven't checked yet and I'm not really good
with punctuation rules in English :)), but even if we fix that typo, current
wording doesn't exactly conform with our general documentation guidelines so I
wanted to rewrite the whole sentence.

Thanks for the review!
Sign in to reply to this message.

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+