This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Docs: Odd phrase "floating seconds" in socket.html
Type: Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Cris.Simpson, beardedp, docs@python, eric.araujo, ezio.melotti, python-dev, terry.reedy
Priority: normal Keywords: easy, patch

Created on 2011-08-11 02:47 by Cris.Simpson, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue12725.patch beardedp, 2011-08-14 03:52 review
Messages (6)
msg141892 - (view) Author: Cris Simpson (Cris.Simpson) Date: 2011-08-11 02:47
In http://docs.python.org/library/socket.html, the description for socket.setdefaulttimeout(timeout) reads: 
    Set the default timeout in *floating seconds* for new socket objects.
[occurs two other times on that page]


"floating seconds" is a confusing construction. 

Suggestion: "float expressing seconds" as per socket.settimeout(value) or "seconds (float)".
msg141984 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-08-12 18:22
I agree 'floating seconds' is bad. I think I prefer your second alternative, but settimeout() and setdefaulttimeout should be consistent.
msg142045 - (view) Author: Ben Hayden (beardedp) * Date: 2011-08-14 03:52
I made the suggested second change - both in the docs & the socketmodule.c file. If there's a different way to patch documentation, someone let me know. :D
msg142049 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-08-14 05:30
New changeset dfe6f0a603d2 by Ezio Melotti in branch '2.7':
#12725: fix working. Patch by Ben Hayden.
http://hg.python.org/cpython/rev/dfe6f0a603d2

New changeset ab3432a81c26 by Ezio Melotti in branch '3.2':
#12725: fix working. Patch by Ben Hayden.
http://hg.python.org/cpython/rev/ab3432a81c26

New changeset 49e9e34da512 by Ezio Melotti in branch 'default':
#12725: merge with 3.2.
http://hg.python.org/cpython/rev/49e9e34da512
msg142050 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-14 05:31
Fixed, thanks for the report and the patch!
msg143487 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-09-04 06:56
New changeset 8730fdc9349f by Ezio Melotti in branch '3.2':
#12725: fix working. Patch by Ben Hayden.
http://hg.python.org/cpython/rev/8730fdc9349f
History
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56934
2011-09-04 06:56:37python-devsetmessages: + msg143487
2011-08-14 05:31:51ezio.melottisetstatus: open -> closed

nosy: + ezio.melotti
messages: + msg142050

resolution: fixed
stage: needs patch -> resolved
2011-08-14 05:30:05python-devsetnosy: + python-dev
messages: + msg142049
2011-08-14 03:52:51beardedpsetfiles: + issue12725.patch

nosy: + beardedp
messages: + msg142045

keywords: + patch
2011-08-12 18:22:28terry.reedysetnosy: + terry.reedy
messages: + msg141984
2011-08-12 16:22:22eric.araujosetkeywords: + easy
nosy: + eric.araujo
stage: needs patch

versions: + Python 3.3, - Python 2.6
2011-08-11 02:47:55Cris.Simpsoncreate