[issue12725] Docs: Odd phrase "floating seconds" in socket.html
New submission from Cris Simpson <crisor@gmail.com>: 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)". ---------- assignee: docs@python components: Documentation messages: 141892 nosy: Cris.Simpson, docs@python priority: normal severity: normal status: open title: Docs: Odd phrase "floating seconds" in socket.html versions: Python 2.6, Python 2.7, Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- keywords: +easy nosy: +eric.araujo stage: -> needs patch versions: +Python 3.3 -Python 2.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: I agree 'floating seconds' is bad. I think I prefer your second alternative, but settimeout() and setdefaulttimeout should be consistent. ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Ben Hayden <hayden767@gmail.com> added the comment: 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 ---------- keywords: +patch nosy: +beardedp Added file: http://bugs.python.org/file22896/issue12725.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Roundup Robot <devnull@psf.upfronthosting.co.za> added the comment: 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 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Ezio Melotti <ezio.melotti@gmail.com> added the comment: Fixed, thanks for the report and the patch! ---------- nosy: +ezio.melotti resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
Roundup Robot <devnull@psf.upfronthosting.co.za> added the comment: New changeset 8730fdc9349f by Ezio Melotti in branch '3.2': #12725: fix working. Patch by Ben Hayden. http://hg.python.org/cpython/rev/8730fdc9349f ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12725> _______________________________________
participants (6)
-
Ben Hayden -
Cris Simpson
-
Ezio Melotti
-
Roundup Robot
-
Terry J. Reedy
-
Éric Araujo