From report at bugs.python.org  Sun Sep  1 08:41:01 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sun, 01 Sep 2013 06:41:01 +0000
Subject: [docs] [issue18313] In itertools recipes repeatfunc() defines a
	non-keyword	argument as keyword
In-Reply-To: <1372309261.95.0.7034101172.issue18313@psf.upfronthosting.co.za>
Message-ID: <1378017661.13.0.987240943027.issue18313@psf.upfronthosting.co.za>


Changes by Raymond Hettinger <raymond.hettinger at gmail.com>:


----------
assignee: docs at python -> rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18313>
_______________________________________

From report at bugs.python.org  Sun Sep  1 11:45:54 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 01 Sep 2013 09:45:54 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1378028754.23.0.965745148045.issue18553@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

None that I know of.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sun Sep  1 19:48:36 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Sun, 01 Sep 2013 17:48:36 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1378057716.36.0.0989504113104.issue18553@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

> Are there tests for this?

Not sure what you mean: there are several tests using isatty() in test suite.

Regardless, there is no #ifdef around the isatty() definition in posixmodule.c, so I can only assume it exists on all platforms.

----------
nosy: +pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Mon Sep  2 01:07:00 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 01 Sep 2013 23:07:00 +0000
Subject: [docs] [issue18870] eval() uses latin-1 to decode str
In-Reply-To: <1377713902.12.0.966249722349.issue18870@psf.upfronthosting.co.za>
Message-ID: <3cSqnH19Jqz7Ljf@mail.python.org>


Roundup Robot added the comment:

New changeset 869cbcabb934 by Benjamin Peterson in branch '2.7':
document that various functions that parse from source will interpret things as latin-1 (closes #18870)
http://hg.python.org/cpython/rev/869cbcabb934

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18870>
_______________________________________

From report at bugs.python.org  Mon Sep  2 19:51:00 2013
From: report at bugs.python.org (Dmi Baranov)
Date: Mon, 02 Sep 2013 17:51:00 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1378144260.23.0.0245098955445.issue18553@psf.upfronthosting.co.za>


Dmi Baranov added the comment:

isatty is a part of of POSIX sub-system at Windows > 5.x (AKA 2000) [1] (file handling equivalents [2]). I think, we need to remove availability note here.

[1] http://msdn.microsoft.com/en-us/library/f4s0ddew.aspx
[2] http://msdn.microsoft.com/en-us/library/kdfaxaay.aspx

----------
nosy: +dmi.baranov

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Tue Sep  3 00:40:00 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 22:40:00 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
Message-ID: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>


New submission from Elazar Gershuni:

Inner sections "leak" out from enum to the general datatypes index:
http://docs.python.org/3.4/library/datatypes.html

(sections 8.14 - 8.17)

----------
assignee: docs at python
components: Documentation
messages: 196816
nosy: docs at python, elazar
priority: normal
severity: normal
status: open
title: Enum docs: sections leak out

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 00:40:42 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 22:40:42 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378161642.89.0.516548991134.issue18908@psf.upfronthosting.co.za>


Elazar Gershuni added the comment:

here's a patch.

----------
keywords: +patch
Added file: http://bugs.python.org/file31561/enumcontain.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 00:47:26 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Mon, 02 Sep 2013 22:47:26 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378162046.93.0.565120948599.issue18908@psf.upfronthosting.co.za>


Changes by Eli Bendersky <eliben at gmail.com>:


----------
nosy: +eli.bendersky, ethan.furman

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 00:47:41 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Mon, 02 Sep 2013 22:47:41 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378162061.13.0.599856303434.issue18908@psf.upfronthosting.co.za>


Changes by Eli Bendersky <eliben at gmail.com>:


----------
stage:  -> patch review
versions: +Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 00:53:42 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 22:53:42 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378162422.65.0.532335990867.issue18908@psf.upfronthosting.co.za>


Changes by Elazar Gershuni <elazarg at gmail.com>:


Added file: http://bugs.python.org/file31562/enumindent.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 01:47:48 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 23:47:48 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378165668.36.0.820559016548.issue18908@psf.upfronthosting.co.za>


Changes by Elazar Gershuni <elazarg at gmail.com>:


Added file: http://bugs.python.org/file31563/enumplusminor.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 01:53:10 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 23:53:10 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378165990.99.0.883681425601.issue18908@psf.upfronthosting.co.za>


Changes by Elazar Gershuni <elazarg at gmail.com>:


Removed file: http://bugs.python.org/file31563/enumplusminor.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 01:53:44 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Mon, 02 Sep 2013 23:53:44 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <1378166024.11.0.443045808276.issue18908@psf.upfronthosting.co.za>


Changes by Elazar Gershuni <elazarg at gmail.com>:


Added file: http://bugs.python.org/file31564/enumplusminor.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Tue Sep  3 05:53:40 2013
From: report at bugs.python.org (Andrew Svetlov)
Date: Tue, 03 Sep 2013 03:53:40 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1378180420.44.0.544394139286.issue18553@psf.upfronthosting.co.za>


Andrew Svetlov added the comment:

Agree

----------
nosy: +asvetlov

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Tue Sep  3 10:08:26 2013
From: report at bugs.python.org (Jeroen Van Goey)
Date: Tue, 03 Sep 2013 08:08:26 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
Message-ID: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>


New submission from Jeroen Van Goey:

The sample code in the itertools.count documentation should be indented by 4 spaces.

For 2.7.4: lines 3429 till 3432 in http://hg.python.org/releasing/2.7.4/file/026ee0057e2d/Modules/itertoolsmodule.c#l3429

For 3.4.0a1: lines 3981 till 3984 in http://hg.python.org/releasing/py3.4.0a1/file/edc668a667ad/Modules/itertoolsmodule.c#l3981

Also, the example code uses the arguments 'firstval' and 'step' whereas the documentation of the function itself uses the arguments 'start' and 'step'. Maybe better be consistent and use as first argument 'start' in both cases?

----------
assignee: docs at python
components: Documentation
hgrepos: 207
messages: 196826
nosy: docs at python, jeroen-vangoey
priority: normal
severity: normal
status: open
title: Intendation issue in example code in itertools.count documentation
type: enhancement
versions: Python 2.7, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 10:08:49 2013
From: report at bugs.python.org (Jeroen Van Goey)
Date: Tue, 03 Sep 2013 08:08:49 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378195729.09.0.688102898658.issue18912@psf.upfronthosting.co.za>


Changes by Jeroen Van Goey <jeroen.vangoey at gmail.com>:


----------
hgrepos:  -207

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 10:31:54 2013
From: report at bugs.python.org (Jeroen Van Goey)
Date: Tue, 03 Sep 2013 08:31:54 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378197114.27.0.934653540395.issue18912@psf.upfronthosting.co.za>


Jeroen Van Goey added the comment:

Patch for Python 2.7.4 attached

----------
keywords: +patch
Added file: http://bugs.python.org/file31571/2.7itertoolsmodule.c.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 10:32:30 2013
From: report at bugs.python.org (Jeroen Van Goey)
Date: Tue, 03 Sep 2013 08:32:30 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378197150.21.0.398833796019.issue18912@psf.upfronthosting.co.za>


Jeroen Van Goey added the comment:

Patch for Python 3.4.0a1 attached

----------
Added file: http://bugs.python.org/file31572/3.4itertoolsmodule.c.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 12:51:10 2013
From: report at bugs.python.org (Andrew Svetlov)
Date: Tue, 03 Sep 2013 10:51:10 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378205470.53.0.739866670629.issue18912@psf.upfronthosting.co.za>


Changes by Andrew Svetlov <andrew.svetlov at gmail.com>:


----------
stage:  -> patch review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From mjsg.public at gmail.com  Mon Sep  2 13:52:14 2013
From: mjsg.public at gmail.com (=?UTF-8?B?5p2O5p+P5oay?=)
Date: Mon, 2 Sep 2013 19:52:14 +0800
Subject: [docs] Demo code error in "Curses Programming with Python"
Message-ID: <CAFE=xWsik9qHE2aHUdqrXc+1ikatQTjii8v73gjxXz0pn+q==w@mail.gmail.com>

Dears:
I found demo code of cruses wrapper() ( the code just before "Windows and
Pads") in docs  "Curses Programming with Python" have some code error.

"    for i in range(0, 10):" should be "    for i in range(11):", or that
would not raises ZeroDivisionError.

Bo-Sian Li
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130902/a9525d08/attachment.html>

From the_first_dreamer at hotmail.com  Mon Sep  2 18:59:05 2013
From: the_first_dreamer at hotmail.com (The Dreamer)
Date: Mon, 2 Sep 2013 16:59:05 +0000
Subject: [docs] Python 3.1.1 - BUG
Message-ID: <DUB125-W51E2AF5828F85837847B2EA4300@phx.gbl>

Encontrei um poss?vel bug no Python 3.1.1

Sempre que coloco uma sequ?ncia de c?digos no IDLE, ele fecha.

Caso ocorra interesse, entre em contato.
 		 	   		  
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130902/0fe356e5/attachment.html>

From elazarg at gmail.com  Tue Sep  3 02:19:36 2013
From: elazarg at gmail.com (=?UTF-8?B?15DXnNei15bXqA==?=)
Date: Tue, 3 Sep 2013 03:19:36 +0300
Subject: [docs] A more concise example for OrederedEnum
Message-ID: <CAPw6O2QTeEDD0BYAPtDfMFS_t6gu30BCRAHUN3ogwNruNh-gyg@mail.gmail.com>

Instead of implementing 4 comparison methods, I suggest using
total_ordering:

>>> from functools import total_ordering
>>> @total_ordering
... class OrderedEnum(Enum):
...     def __gt__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value > other.value
...         return NotImplemented
...

I believe the reader needn't be famiiar with total_ordering() to understand
what's going on here.

elazar
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130903/4c78fbad/attachment.html>

From andrew.svetlov at gmail.com  Tue Sep  3 14:40:27 2013
From: andrew.svetlov at gmail.com (Andrew Svetlov)
Date: Tue, 3 Sep 2013 15:40:27 +0300
Subject: [docs] defaults redirects bit confusing
In-Reply-To: <CAF94-jboFPdNjPndyoBqC0EWtPzjzVW-uwnVNqQicZH3A3m1Dw@mail.gmail.com>
References: <CAF94-jboFPdNjPndyoBqC0EWtPzjzVW-uwnVNqQicZH3A3m1Dw@mail.gmail.com>
Message-ID: <CAL3CFcWWLK8W0k11mN3x5AnrG22GF+xXRiPBcMN-BgiEiEne8w@mail.gmail.com>

It's intended, see http://www.python.org/dev/peps/pep-0430/

On Fri, Aug 30, 2013 at 11:52 PM, Luca Sbardella
<luca.sbardella at gmail.com> wrote:
> Hi,
> just noticed that
> http://docs.python.org/
> redirect to
> http://docs.python.org/3/
> good
> but
> http://docs.python.org/library/
> redirect to
> http://docs.python.org/2/library/
> not good if not confusing
>
> am I missing something?
>
> Regards
>
>
>
> _______________________________________________
> docs mailing list
> docs at python.org
> https://mail.python.org/mailman/listinfo/docs
>



-- 
Thanks,
Andrew Svetlov

From andrew.svetlov at gmail.com  Tue Sep  3 14:54:06 2013
From: andrew.svetlov at gmail.com (Andrew Svetlov)
Date: Tue, 3 Sep 2013 15:54:06 +0300
Subject: [docs] socket.sethostname() error type mistake
In-Reply-To: <CAGwyPpFM5TNgbO26vdxhkj+baDx3T7MvjAXb=V6oUe+KbyW6iw@mail.gmail.com>
References: <CAGwyPpFM5TNgbO26vdxhkj+baDx3T7MvjAXb=V6oUe+KbyW6iw@mail.gmail.com>
Message-ID: <CAL3CFcW65gKGKYoM4GhVB4kJ67TLat5363RRK3d5RTWHVNTk_A@mail.gmail.com>

PermissionError is subclass of OSError.
There are outer possible errors by socket.sethostname() call, so doc is correct.

On Mon, Aug 12, 2013 at 6:42 PM, Simeon S <simeon.simeonov.s at gmail.com> wrote:
> Hi,
>
> I believe there is a mistake in the type of error raised by
> socket.sethostname(). The documentation says the error returned is
> OSError. Here is what I get (3.3.2):
>
> [16:39:sys]
>  % python3
> Python 3.3.2 (default, Aug  5 2013, 11:52:10)
> [GCC 4.5.3] on linux
> Type "help", "copyright", "credits" or "license" for more information.
>>>> import socket as s
>>>> s.sethostname('bla')
> Traceback (most recent call last):
>   File "<stdin>", line 1, in <module>
> PermissionError: [Errno 1] Operation not permitted
>
> Simeon
> _______________________________________________
> docs mailing list
> docs at python.org
> https://mail.python.org/mailman/listinfo/docs



-- 
Thanks,
Andrew Svetlov

From report at bugs.python.org  Tue Sep  3 15:35:51 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Tue, 03 Sep 2013 13:35:51 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378215351.38.0.199554593774.issue18912@psf.upfronthosting.co.za>


Eli Bendersky added the comment:

LGTM, thanks

----------
nosy: +eli.bendersky

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 15:39:27 2013
From: report at bugs.python.org (Roundup Robot)
Date: Tue, 03 Sep 2013 13:39:27 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <3cTq5V1P41z7Ljb@mail.python.org>


Roundup Robot added the comment:

New changeset 8e174ee0575a by Eli Bendersky in branch '3.3':
Issue #18912: Fix indentation in docstring
http://hg.python.org/cpython/rev/8e174ee0575a

New changeset 31ef590a0d2f by Eli Bendersky in branch 'default':
Issue #18912: Fix indentation in docstring
http://hg.python.org/cpython/rev/31ef590a0d2f

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Tue Sep  3 15:42:30 2013
From: report at bugs.python.org (Roundup Robot)
Date: Tue, 03 Sep 2013 13:42:30 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <3cTq911DQ2z7Lkh@mail.python.org>


Roundup Robot added the comment:

New changeset a559cda6a498 by Eli Bendersky in branch '2.7':
Close #18912: Fix indentation in docstring
http://hg.python.org/cpython/rev/a559cda6a498

----------
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From bgailer at gmail.com  Tue Sep  3 16:32:20 2013
From: bgailer at gmail.com (bob gailer)
Date: Tue, 03 Sep 2013 10:32:20 -0400
Subject: [docs] Newcomer to document maintenance - regarding @staticmethod
Message-ID: <5225F2F4.3000704@gmail.com>

I'd like a stab at submitting a fix. The process seems daunting, and I 
seek some hand-holding.

< Problem: Chapter 2 Built-in Functions - staticmethod()

"The @staticmethod form is a function /decorator/ 
<../glossary.html#term-decorator> ? see the description of function 
definitions in /Function definitions/ 
<../reference/compound_stmts.html#function> for details."

< Clearer:

Example of applying staticmethod() using the decorator idiom:

existing code example

See description of /decorator /in Function definitions. 
<../reference/compound_stmts.html#function>

< link /decorator / to the paragraph starting A function definition may 
be wrapped by one or more /decorator/ <../glossary.html#term-decorator> 
expressions".

< Precede that paragraph with *Decorators*.

< I also question the value of /decorator/ 
<../glossary.html#term-decorator> expressions linking to the glossary, 
as the glossary entry does not add to the explanation.

-- 
Bob Gailer
919-636-4239
Chapel Hill NC


From report at bugs.python.org  Tue Sep  3 19:30:20 2013
From: report at bugs.python.org (Brian Mingus)
Date: Tue, 03 Sep 2013 17:30:20 +0000
Subject: [docs] [issue18914] Python docs link to terrible outsi
Message-ID: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>


New submission from Brian Mingus:

The python documentation links to an outside website for info and examples on http basic auth. This documentation is terrible and confusing. The link should be removed, and user's should be advised to use the Requests library.


# this example is from http://www.voidspace.org.uk/python/articles/authentication.shtml
# which is linked to by the official python docs http://docs.python.org/2/howto/urllib2.html

import urllib2
 
theurl = 'http://www.someserver.com/toplevelurl/somepage.htm'
username = 'johnny'
password = 'XXXXXX'
# a great password
 
passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
# this creates a password manager
passman.add_password(None, theurl, username, password)
# because we have put None at the start it will always
# use this username/password combination for  urls
# for which `theurl` is a super-url
 
authhandler = urllib2.HTTPBasicAuthHandler(passman)
# create the AuthHandler
 
opener = urllib2.build_opener(authhandler)
 
urllib2.install_opener(opener)
# All calls to urllib2.urlopen will now use our handler
# Make sure not to include the protocol in with the URL, or
# HTTPPasswordMgrWithDefaultRealm will be very confused.
# You must (of course) use it when fetching the page though.
 
pagehandle = urllib2.urlopen(theurl)
# authentication is now handled automatically for us

----------
assignee: docs at python
components: Documentation
messages: 196854
nosy: docs at python, mingus
priority: normal
severity: normal
status: open
title: Python docs link to terrible outsi
versions: Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 20:16:41 2013
From: report at bugs.python.org (Ned Deily)
Date: Tue, 03 Sep 2013 18:16:41 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378232201.16.0.905548544715.issue18914@psf.upfronthosting.co.za>


Changes by Ned Deily <nad at acm.org>:


----------
nosy: +michael.foord
title: Python docs link to terrible outsi -> Confusing documentation in the urllib2 HOWTO

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 21:00:37 2013
From: report at bugs.python.org (R. David Murray)
Date: Tue, 03 Sep 2013 19:00:37 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378234837.7.0.878643370531.issue18914@psf.upfronthosting.co.za>


R. David Murray added the comment:

Suggesting using a 3rd party library in order to explain how to use the python standard library to do something isn't going to work.

Would you like to propose an alternate article or an improvement to the howto, using only stdlib facilities?

(Note that the external web page linked to is that of an active Python core contributor.)

----------
nosy: +r.david.murray

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 21:02:28 2013
From: report at bugs.python.org (Brian Mingus)
Date: Tue, 03 Sep 2013 19:02:28 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378234948.5.0.446808276805.issue18914@psf.upfronthosting.co.za>


Brian Mingus added the comment:

The documentation is confusing. Consider this comment:

# All calls to urllib2.urlopen will now use our handler
# Make sure not to include the protocol in with the URL, or
# HTTPPasswordMgrWithDefaultRealm will be very confused.
# You must (of course) use it when fetching the page though.

In the actual code he provides, he uses the protocol. Furthermore, before showing a simple way to use the libary, he shows a godawfully complex way. 

Either the documentation should made beautiful and comprehensible, or it should not be linked to.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 21:12:02 2013
From: report at bugs.python.org (R. David Murray)
Date: Tue, 03 Sep 2013 19:12:02 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378235522.75.0.660769489432.issue18914@psf.upfronthosting.co.za>


R. David Murray added the comment:

The article is *explaining* basic auth, thus the pedegogy of the presentation, and why it is a "see also" and not part of the docs proper.

I'll admit I don't understand the first part of that comment, since the second part says you do have to put the protocol in the URL, which is what the example does.

As I said, would you care to propose a replacement?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 21:14:09 2013
From: report at bugs.python.org (Brian Mingus)
Date: Tue, 03 Sep 2013 19:14:09 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378235649.21.0.151055603693.issue18914@psf.upfronthosting.co.za>


Brian Mingus added the comment:

Yes - this link was a waste of my time. It would have been better if it had not been there. I propose to replace it with nothing.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Tue Sep  3 22:31:09 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Tue, 03 Sep 2013 20:31:09 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378240269.23.0.249198387851.issue18914@psf.upfronthosting.co.za>


Changes by Senthil Kumaran <senthil at uthcode.com>:


----------
nosy: +orsenthil

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Wed Sep  4 00:37:30 2013
From: report at bugs.python.org (Michael Foord)
Date: Tue, 03 Sep 2013 22:37:30 +0000
Subject: [docs] [issue18914] Confusing documentation in the urllib2 HOWTO
In-Reply-To: <1378229420.77.0.30621022035.issue18914@psf.upfronthosting.co.za>
Message-ID: <1378247850.85.0.0369825293616.issue18914@psf.upfronthosting.co.za>


Michael Foord added the comment:

As David explained, the linked article *explains* basic auth as well as showing how to use the standard library support. I think the article is still of some value, it has certainly been useful to many people.

----------
resolution:  -> wont fix
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18914>
_______________________________________

From report at bugs.python.org  Wed Sep  4 05:00:22 2013
From: report at bugs.python.org (Nikolaus Rath)
Date: Wed, 04 Sep 2013 03:00:22 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1312654346.88.0.619161172388.issue12704@psf.upfronthosting.co.za>
Message-ID: <1378263622.12.0.515186604639.issue12704@psf.upfronthosting.co.za>


Nikolaus Rath added the comment:

*ping*

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Wed Sep  4 06:40:20 2013
From: report at bugs.python.org (bussau)
Date: Wed, 04 Sep 2013 04:40:20 +0000
Subject: [docs] [issue18918] help('FILES') finds no documentation
Message-ID: <1378269620.52.0.763555902483.issue18918@psf.upfronthosting.co.za>


New submission from bussau:

Calling for help() about the topic 'FILES' returns 

no documentation found for 'FILES'
------------------------------

Python 2.7.3 (default, Apr 14 2012, 08:58:41) [GCC] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> help('topics')

Here is a list of available topics.  Enter any topic name to get more help.

ASSERTION           DEBUGGING           LITERALS            SEQUENCEMETHODS2
ASSIGNMENT          DELETION            LOOPING             SEQUENCES
ATTRIBUTEMETHODS    DICTIONARIES        MAPPINGMETHODS      SHIFTING
ATTRIBUTES          DICTIONARYLITERALS  MAPPINGS            SLICINGS
AUGMENTEDASSIGNMENT DYNAMICFEATURES     METHODS             SPECIALATTRIBUTES
BACKQUOTES          ELLIPSIS            MODULES             SPECIALIDENTIFIERS
BASICMETHODS        EXCEPTIONS          NAMESPACES          SPECIALMETHODS
BINARY              EXECUTION           NONE                STRINGMETHODS
BITWISE             EXPRESSIONS         NUMBERMETHODS       STRINGS
BOOLEAN             FILES               NUMBERS             SUBSCRIPTS
CALLABLEMETHODS     FLOAT               OBJECTS             TRACEBACKS
CALLS               FORMATTING          OPERATORS           TRUTHVALUE
CLASSES             FRAMEOBJECTS        PACKAGES            TUPLELITERALS
CODEOBJECTS         FRAMES              POWER               TUPLES
COERCIONS           FUNCTIONS           PRECEDENCE          TYPEOBJECTS
COMPARISON          IDENTIFIERS         PRINTING            TYPES
COMPLEX             IMPORTING           PRIVATENAMES        UNARY
CONDITIONAL         INTEGER             RETURNING           UNICODE
CONTEXTMANAGERS     LISTLITERALS        SCOPING             
CONVERSIONS         LISTS               SEQUENCEMETHODS1    

>>> help('FILES')
no documentation found for 'FILES'

--------------------------------------------------------

best regards
stephan

----------
assignee: docs at python
components: Documentation, Interpreter Core
messages: 196888
nosy: docs at python, st.sempert at gmail.com
priority: normal
severity: normal
status: open
title: help('FILES') finds no documentation
type: behavior
versions: Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18918>
_______________________________________

From report at bugs.python.org  Wed Sep  4 07:49:15 2013
From: report at bugs.python.org (Ramchandra Apte)
Date: Wed, 04 Sep 2013 05:49:15 +0000
Subject: [docs] [issue18918] help('FILES') finds no documentation
In-Reply-To: <1378269620.52.0.763555902483.issue18918@psf.upfronthosting.co.za>
Message-ID: <1378273755.45.0.188603960504.issue18918@psf.upfronthosting.co.za>


Ramchandra Apte added the comment:

I am able to reproduce on Python 3.3 as well.

----------
components:  -Interpreter Core
nosy: +Ramchandra Apte
versions: +Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18918>
_______________________________________

From report at bugs.python.org  Wed Sep  4 09:31:41 2013
From: report at bugs.python.org (Berker Peksag)
Date: Wed, 04 Sep 2013 07:31:41 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1312654346.88.0.619161172388.issue12704@psf.upfronthosting.co.za>
Message-ID: <1378279901.06.0.83886508648.issue12704@psf.upfronthosting.co.za>


Changes by Berker Peksag <berker.peksag at gmail.com>:


----------
nosy: +pje
versions:  -Python 2.6, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Wed Sep  4 15:03:48 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Wed, 04 Sep 2013 13:03:48 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1312654346.88.0.619161172388.issue12704@psf.upfronthosting.co.za>
Message-ID: <1378299828.64.0.605084555396.issue12704@psf.upfronthosting.co.za>


Eli Bendersky added the comment:

Why guess... did you try it in the code?

Trying has another goal - it would be nice to have a short code sample here demonstrating what's happening. The paragraph you're quoting seems obscure to me, with or without the fix.

----------
nosy: +eli.bendersky

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Wed Sep  4 22:53:58 2013
From: report at bugs.python.org (Giampaolo Rodola')
Date: Wed, 04 Sep 2013 20:53:58 +0000
Subject: [docs] [issue18925] select.poll.modify is not documented
Message-ID: <1378328037.99.0.424927131422.issue18925@psf.upfronthosting.co.za>


New submission from Giampaolo Rodola':

It was introduced in Python 2.6:
http://bugs.python.org/issue1657
Will commit a patch soon.

----------
assignee: docs at python
components: Documentation
messages: 196953
nosy: docs at python, giampaolo.rodola
priority: normal
severity: normal
status: open
title: select.poll.modify is not documented
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18925>
_______________________________________

From report at bugs.python.org  Wed Sep  4 23:54:08 2013
From: report at bugs.python.org (Tim Peters)
Date: Wed, 04 Sep 2013 21:54:08 +0000
Subject: [docs] [issue18927] Lock.acquire() docs incorrect about negative
	timeout
Message-ID: <1378331648.69.0.879815072803.issue18927@psf.upfronthosting.co.za>


New submission from Tim Peters:

Here from the 3.3.2 docs for threading.Lock:

"""
acquire(blocking=True, timeout=-1) 
Acquire a lock, blocking or non-blocking.

...

When invoked with the floating-point timeout argument set to a positive value, block for at most the number of seconds specified by timeout and as long as the lock cannot be acquired. A negative timeout argument specifies an unbounded wait. 

...

"""

However, that's not what the code does for a negative timeout:

>>> from threading import Lock
>>> x = Lock()
>>> x.acquire(1, -0.2)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: timeout value must be strictly positive

The only negative value the code allows is -1, in lock_PyThread_acquire_lock():

    if (timeout < 0 && timeout != -1) {
        PyErr_SetString(PyExc_ValueError, "timeout value must be "
                        "strictly positive");
        return NULL;
    }

The docs should change to say that -1 is special ;-)

----------
assignee: docs at python
components: Documentation
keywords: easy
messages: 196960
nosy: docs at python, tim.peters
priority: normal
severity: normal
status: open
title: Lock.acquire() docs incorrect about negative timeout
type: behavior
versions: Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18927>
_______________________________________

From report at bugs.python.org  Thu Sep  5 00:05:44 2013
From: report at bugs.python.org (STINNER Victor)
Date: Wed, 04 Sep 2013 22:05:44 +0000
Subject: [docs] [issue18925] select.poll.modify is not documented
In-Reply-To: <1378328037.99.0.424927131422.issue18925@psf.upfronthosting.co.za>
Message-ID: <1378332344.83.0.749582157394.issue18925@psf.upfronthosting.co.za>


STINNER Victor added the comment:

For your information, epoll.closed and kqueue.closed were not documented. I documented them recently in Python 3.4 doc.

----------
nosy: +haypo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18925>
_______________________________________

From report at bugs.python.org  Thu Sep  5 02:18:34 2013
From: report at bugs.python.org (David Benbennick)
Date: Thu, 05 Sep 2013 00:18:34 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
Message-ID: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>


New submission from David Benbennick:

Since Python 2.1 [1], when random.shuffle was added, the documentation has said:

"""Note that for even rather small len(x), the total number of permutations of x is larger than the period of most random number generators; this implies that most permutations of a long sequence can never be generated."""

This comment is incorrect and misleading.  In fact, I claim that shuffle can produce "all" permutations for any representable sequence.

To shuffle a sequence of length N requires log(N!) ~ N * log(N/e) bits of randomness [2].  The random module provides a generator with "a period of 2**19937-1", meaning you can get 2**19937 bits of randomness out of it before it starts repeating.

All of which is to say that any representable sequence, say N < 2**50, will need no more than 2**60 bits of randomness to shuffle.  That is well within the period of the random number generator.

Attached is a patch that deletes the comment.

An illustration of this misconception is at [3].


1: http://docs.python.org/release/2.1/lib/module-random.html
2: https://en.wikipedia.org/wiki/Factorial#Rate_of_growth_and_approximations_for_large_n
3: http://stackoverflow.com/questions/3062741/maximal-length-of-list-to-shuffle-with-python-random-shuffle

----------
assignee: docs at python
components: Documentation
files: mywork.patch
keywords: patch
messages: 196971
nosy: dbenbenn, docs at python
priority: normal
severity: normal
status: open
title: Remove misleading documentation for random.shuffle
Added file: http://bugs.python.org/file31593/mywork.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 02:27:16 2013
From: report at bugs.python.org (Nikolaus Rath)
Date: Thu, 05 Sep 2013 00:27:16 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1378299828.64.0.605084555396.issue12704@psf.upfronthosting.co.za>
Message-ID: <5227CFDA.2050801@rath.org>


Nikolaus Rath added the comment:

On 09/04/2013 06:03 AM, Eli Bendersky wrote:
> Why guess... did you try it in the code?

I don't follow... why guess what? And try what in code?

> it would be nice to have a short code sample here demonstrating what's happening. The paragraph you're quoting seems obscure to me, with or without the fix.

Sounds reasonable. I'll revise the patch and add an example.

Best,

   -Nikolaus

-- 
 ?Time flies like an arrow, fruit flies like a Banana.?

  PGP fingerprint: 5B93 61F8 4EA2 E279 ABF6  02CF A9AD B7F8 AE4E 425C

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Thu Sep  5 05:11:00 2013
From: report at bugs.python.org (R. David Murray)
Date: Thu, 05 Sep 2013 03:11:00 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
In-Reply-To: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>
Message-ID: <1378350660.5.0.624542182524.issue18928@psf.upfronthosting.co.za>


R. David Murray added the comment:

It seems to me that 2080 (per the accepted answer to your [3]) is indeed "a rather small len(x)", and that the docs are correct as written.

I wonder if it would be worth adding a footnote that explains how to calculate that example 2080 number from the documented period of the random number generator, to make the concepts involved a little bit clearer?

----------
nosy: +r.david.murray, rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 05:20:43 2013
From: report at bugs.python.org (R. David Murray)
Date: Thu, 05 Sep 2013 03:20:43 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
In-Reply-To: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>
Message-ID: <1378351243.78.0.0611822809763.issue18928@psf.upfronthosting.co.za>


R. David Murray added the comment:

Alternatively, you would have to supply (or supply a pointer to) a mathematical proof of your thesis.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 05:48:15 2013
From: report at bugs.python.org (Tim Peters)
Date: Thu, 05 Sep 2013 03:48:15 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1312654346.88.0.619161172388.issue12704@psf.upfronthosting.co.za>
Message-ID: <1378352895.7.0.507135141344.issue12704@psf.upfronthosting.co.za>


Tim Peters added the comment:

I think the docs are already clear:  they say "the generator-iterator?s close() method will be called".  That's all that needs to be said:  now go look at the docs for generator.close().  They explain _all_ that close() does, and it would be a Bad Idea to duplicate all that in this part of the docs too.  (And, yes, for a start, close() "Raises a GeneratorExit at the point where the generator function was paused".)

It would certainly help if the "close" (in "the generator-iterator?s close() method will be called") were an active hyperlink in the docs.

----------
nosy: +tim.peters

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Thu Sep  5 06:20:34 2013
From: report at bugs.python.org (Tim Peters)
Date: Thu, 05 Sep 2013 04:20:34 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
In-Reply-To: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>
Message-ID: <1378354834.03.0.230262854684.issue18928@psf.upfronthosting.co.za>


Tim Peters added the comment:

When the comment was introduced, Python's Wichmann-Hill generator had a much shorter period, and we couldn't even generate all the permutations of a deck of cards.

The period is astronomically larger now, but the stackoverflow answer (2080) is correct for the current upper bound.  The docs could be beefed up to say more about that - but they'd get awfully tedious ;-)

To the OP, this is your error:  it takes lg(N!) "bits of randomness" (lg is the logarithm to base 2) to generate _one_ random permutation.  That says nothing about what's needed to generate _all_ permutations.

With an RNG of period P, there are P possible starting states.  The starting state wholly determines the permutation produced.  Therefore an RNG of period P cannot generate more than P distinct permutations (and that's an absolute upper bound - it may not be achieved).  That's why comparing N! to P is the correct computation here, and indeed:

>>> math.factorial(2080) > 2**19937 - 1
False
>>> math.factorial(2081) > 2**19937 - 1
True

If you still don't believe it, here's a challenge:  take a toy RNG with a small period, and use it to generate permutations (via any method you like).  You'll find that you never get more distinct permutations than the period of your RNG.  Then reread the above ;-)

----------
nosy: +tim.peters

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 07:14:16 2013
From: report at bugs.python.org (David Benbennick)
Date: Thu, 05 Sep 2013 05:14:16 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
In-Reply-To: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>
Message-ID: <1378358056.14.0.745824190972.issue18928@psf.upfronthosting.co.za>


David Benbennick added the comment:

Okay, I see what the comment is saying now.  I was mistaken.

It might make the statement clearer if it is made more precise.  "rather small" is vague.  That vagueness is intentional, but it makes it more confusing.

----------
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 07:40:10 2013
From: report at bugs.python.org (Tim Peters)
Date: Thu, 05 Sep 2013 05:40:10 +0000
Subject: [docs] [issue18928] Remove misleading documentation for
	random.shuffle
In-Reply-To: <1378340314.25.0.0317280223826.issue18928@psf.upfronthosting.co.za>
Message-ID: <1378359610.33.0.166874908629.issue18928@psf.upfronthosting.co.za>


Changes by Tim Peters <tim at python.org>:


----------
resolution:  -> invalid
stage:  -> committed/rejected

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18928>
_______________________________________

From report at bugs.python.org  Thu Sep  5 08:45:42 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Thu, 05 Sep 2013 06:45:42 +0000
Subject: [docs] [issue18912] Intendation issue in example code in
	itertools.count	documentation
In-Reply-To: <1378195706.84.0.122771342837.issue18912@psf.upfronthosting.co.za>
Message-ID: <1378363542.22.0.86100733076.issue18912@psf.upfronthosting.co.za>


Raymond Hettinger added the comment:

Please assign itertools doc changes to me in the future.

----------
nosy: +rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18912>
_______________________________________

From report at bugs.python.org  Thu Sep  5 16:10:07 2013
From: report at bugs.python.org (Jonathan Frere)
Date: Thu, 05 Sep 2013 14:10:07 +0000
Subject: [docs] [issue18933] Add link to source code in logging documentation
Message-ID: <1378390206.88.0.825858805448.issue18933@psf.upfronthosting.co.za>


New submission from Jonathan Frere:

The logging module documentation is probably best accompanied by the source that it is meant to be documenting.  Could a link to either the package directory (http://hg.python.org/cpython/file/2.7/Lib/logging/) or the __init__.py file in that directory (http://hg.python.org/cpython/file/2.7/Lib/logging/__init__.py), I'd argue the __init__.py file.

----------
assignee: docs at python
components: Documentation, Library (Lib)
messages: 197000
nosy: Johz, docs at python, vinay.sajip
priority: normal
severity: normal
status: open
title: Add link to source code in logging documentation
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18933>
_______________________________________

From report at bugs.python.org  Thu Sep  5 17:01:34 2013
From: report at bugs.python.org (Vinay Sajip)
Date: Thu, 05 Sep 2013 15:01:34 +0000
Subject: [docs] [issue18933] Add link to source code in logging documentation
In-Reply-To: <1378390206.88.0.825858805448.issue18933@psf.upfronthosting.co.za>
Message-ID: <1378393294.26.0.903851038693.issue18933@psf.upfronthosting.co.za>


Vinay Sajip added the comment:

Why for the logging module in particular? This isn't the norm for stdlib packages, AFAIK.

The logging documentation (both tutorial and reference) is supposed to stand on its own, and in general I don't expect documentation users to (have to) look at the source to understand how to use logging.

If you think particular aspects of the documentation need clarifying, then please indicate what they are and suggest what sort of improvements you think are in order.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18933>
_______________________________________

From report at bugs.python.org  Thu Sep  5 17:57:57 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Thu, 05 Sep 2013 15:57:57 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <5227CFDA.2050801@rath.org>
Message-ID: <CAF-Rda-62NbYLVFx9KqNGFoPtdAkUbqmCLDwJQw-D9pfC16Dgg@mail.gmail.com>


Eli Bendersky added the comment:

On Wed, Sep 4, 2013 at 5:27 PM, Nikolaus Rath <report at bugs.python.org>wrote:

>
> Nikolaus Rath added the comment:
>
> On 09/04/2013 06:03 AM, Eli Bendersky wrote:
> > Why guess... did you try it in the code?
>
> I don't follow... why guess what? And try what in code?
>

I was referring to this part of the original report:

"""
This strongly suggests that the last-executed yield statement will raise an
exception if the generator is closed. If this is the case, it would be
great if the documentation could be extended to say what exception is
raised.

If this is not the case, it would be great if whatever magic is happening
could be documented as well.
"""

If this is the case, if this is not the case... I was just saying that you
can provide some sample code in the issue that demonstrates what *actually*
happens and whether it's not explained well enough in the documentation.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Thu Sep  5 18:44:41 2013
From: report at bugs.python.org (Jonathan Frere)
Date: Thu, 05 Sep 2013 16:44:41 +0000
Subject: [docs] [issue18933] Add link to source code in logging documentation
In-Reply-To: <1378390206.88.0.825858805448.issue18933@psf.upfronthosting.co.za>
Message-ID: <1378399481.48.0.210289320453.issue18933@psf.upfronthosting.co.za>


Jonathan Frere added the comment:

Well, if all the modules could link back to source code, that would be ideal, it's just the logging happens to be the one that I keep coming back to.  Encouraging users to read the source will hopefully help people understand the modules they're using conceptually, and also give people more sample code to use.

That said, a number of modules link back to the source, particularly small single-file implementations of things, such as glob, fnmatch, string, pprint, repr, types, UserDict, weakref, Queue, sched, to name a few that I randomly opened.

Why logging in particular?  Well, as I said, I keep on coming back to it, so at least one Python user feels this need.  Secondly, it's a module that perhaps isn't quite as conceptually clear as others (hence the 'alternatives' that abound).  Thirdly, parts of the module such as logging.handlers will be directly used as templates by many developers.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18933>
_______________________________________

From report at bugs.python.org  Fri Sep  6 00:02:40 2013
From: report at bugs.python.org (Graham Wideman)
Date: Thu, 05 Sep 2013 22:02:40 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
Message-ID: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>


New submission from Graham Wideman:

http://docs.python.org/dev/library/venv.html

More detail needed regarding the original python environment

The article explains how to use venv to create a new python installation with independent libraries etc, and a means to activate one or another virtual python environment. However, there are some points regarding the original python environment which are cloudy.

(1) After pyvenv, what status does the original python installation have? Does pyvenv turn it into just one of now two or more virtual environments? Or is the original one special? Must it be specifically deactivated in order to activate a (different) virtual environment?

(2) The motivation behind venv seems to be to create virtual enviroments that can be substantially or completely separate from the system site directories or from the original python that pyvenv was run from.  Yet elsewhere the doc discusses how  pyvenv creates a pyvenv.cfg file with a home key pointing back to the originating Python installation, and "sys.base_prefix and sys.base_exec_prefix point to the non-venv Python installation which was used to create the venv."... which suggest that a venv is _not_ independent of its creating Python installation.

It would be helpful to provide some context for this seemingly contradictory information.  Perhaps there are scenarios with differing degrees of independence, in which these pointers back to the originating Python installation may or may not be relevant?

(3) How do you proceed to create virtual environments from scratch when you have no initial python installation, or no python installation of that python version?

-- Hope these suggestions help.

----------
assignee: docs at python
components: Documentation
messages: 197030
nosy: docs at python, gwideman
priority: normal
severity: normal
status: open
title: Venv docs regarding original python install
type: behavior
versions: Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 00:02:58 2013
From: report at bugs.python.org (Roundup Robot)
Date: Thu, 05 Sep 2013 22:02:58 +0000
Subject: [docs] [issue18933] Add link to source code in logging documentation
In-Reply-To: <1378390206.88.0.825858805448.issue18933@psf.upfronthosting.co.za>
Message-ID: <3cWG9Y3pbkz7LjT@mail.python.org>


Roundup Robot added the comment:

New changeset dc4e6b48c321 by Vinay Sajip in branch '2.7':
Issue #18933: Added links to source code.
http://hg.python.org/cpython/rev/dc4e6b48c321

New changeset 34e515f2fdfe by Vinay Sajip in branch '3.3':
Issue #18933: Added links to source code.
http://hg.python.org/cpython/rev/34e515f2fdfe

New changeset c5924523747e by Vinay Sajip in branch 'default':
Closes #18933: Merged update from 3.3.
http://hg.python.org/cpython/rev/c5924523747e

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18933>
_______________________________________

From report at bugs.python.org  Fri Sep  6 04:02:58 2013
From: report at bugs.python.org (Graham Wideman)
Date: Fri, 06 Sep 2013 02:02:58 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378432978.72.0.412156225351.issue18939@psf.upfronthosting.co.za>


Graham Wideman added the comment:

Additionally on the subject of venv docs:  I would encourage making it more clear regarding how activate changes the user's PATH. Both http://www.python.org/dev/peps/pep-0405/  and http://docs.python.org/3.3/library/venv.html  talk about how activate adds the activated python binary to the path, but doesn't mention what path:  The one for the current console session? The system PATH environment variable (Windows) or one of the bash startup scripts (unix)? This is important, because it determines how far-reaching is activation of a particular virtual environment.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 04:39:59 2013
From: report at bugs.python.org (R. David Murray)
Date: Fri, 06 Sep 2013 02:39:59 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378435199.39.0.513955602251.issue18939@psf.upfronthosting.co.za>


R. David Murray added the comment:

Hmm.  It seems to me that that document is indeed not clear as to what is really going on.  My understanding has always been that there is only one Python interpreter, but that it behaves differently when invoked through the symlink in the venv.  I suppose that on Windows platforms where symlink isn't available it must actually copy the whole binary, but I don't use Windows so I don't know for sure.  (So, to answer one of your questions, you *can't* create a venv for a Python you don't already have installed.)

It should also mention that the activation is per-shell-session, which would answer some of your other questions.

----------
nosy: +r.david.murray, vinay.sajip

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 05:07:27 2013
From: report at bugs.python.org (Graham Wideman)
Date: Fri, 06 Sep 2013 03:07:27 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378436847.67.0.425426260956.issue18939@psf.upfronthosting.co.za>


Graham Wideman added the comment:

Thanks R. David for your comments.

> It should also mention that the activation is per-shell-session,

.. which also has implications (or lack of effect) for launching from Windows Explorer, for example.

Seems like in practical use, one would need to set up a batch file or shell script to run a particular venv activate command and launch a command shell with that python environment already set up. "Shell for python 2.7.5 and library XYZ" etc.

Advice along these lines would be helpful.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 10:25:54 2013
From: report at bugs.python.org (Vinay Sajip)
Date: Fri, 06 Sep 2013 08:25:54 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378455954.45.0.98889043284.issue18939@psf.upfronthosting.co.za>


Vinay Sajip added the comment:

The venv documentation does assume that the reader knows what virtual environments are and how they work. More details are available in PEP 405, which is not referenced in this documentation - I will rectify that.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 10:51:55 2013
From: report at bugs.python.org (Roundup Robot)
Date: Fri, 06 Sep 2013 08:51:55 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <3cWXZL4d8Pz7LjN@mail.python.org>


Roundup Robot added the comment:

New changeset ad09332f856f by Vinay Sajip in branch '3.3':
Issue #18939: Updated venv documentation with some clarifications.
http://hg.python.org/cpython/rev/ad09332f856f

New changeset 408b6b3dcf9a by Vinay Sajip in branch 'default':
Closes #18939: Merged documentation update from 3.3.
http://hg.python.org/cpython/rev/408b6b3dcf9a

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Fri Sep  6 23:17:45 2013
From: report at bugs.python.org (Graham Wideman)
Date: Fri, 06 Sep 2013 21:17:45 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378502264.93.0.683278564466.issue18939@psf.upfronthosting.co.za>


Graham Wideman added the comment:

@Vinay Sajip  Thanks for looking at this issue and adding the link to PEP 405, and your explanation "When working..." with helpful shebang comments.

That said, the combination of PEP 405 and this updated page doesn't clear things up completely.

Vinay remarks "The venv documentation does assume that the reader knows what virtual environments are and how they work."

If so, let's have a link to where the reader can get up to speed on how they work. PEP 405 is a help, but doesn't detail the topics I raised in earlier thread messages. Also, different legacy virtual environment schemes work differently, so prior knowledge doesn't necessarily help.

But the article already has a link to "virtual environments"... to a box in the same article, which is at the heart of not bringing clarity to the topics at hand.

One problem is lack of clarity about what "active" and "activate" means. Here is what I currently believe:

In connection with venv, the term "active" is used in two relatively trivial but subtly different ways. 

(1) "First on PATH": The phrase "active environment" may be used to simply indicate the python environment which will be found first via the user's shell PATH. Further, each venv-configured python virtual environment installation includes an "activate" script whose main effect is just to add that environment's bin or Scripts directory to the beginning of the user's PATH. This makes the selected python environment the default when the user types the 'python' command. This use of "active" or "activate" might better be termed "default or "make default".

(2) "Actually running": A second meaning of "active" refers to an actually running instance of a python interpreter and its associated environment, whether or not it is first in the user's PATH. Any installed python (virtual or not) may be launched by explicitly invoking the complete path to its executable (eg: C:\python33\python.exe), whereupon that version of python will run, with its associated sys.path and so on.

These two meanings are obviously related. The particular python environment (virtual or not) that is "active" in the first sense, when invoked by a plain "python" command, will become "active" in the second sense.  But a running python ("active" in the second sense) will not necessarily be the "active" one in the first sense.

Implications for installers: A library installer invoked from the command line, unless told otherwise, will presumably install its payload into the python environment found via PATH. Consequently, in preparation, the intended target python should be made "active" in the first sense.

I have not elaborated here on my other concern (since I don't understand the details) -- clarification of different degrees of isolation/autonomy which can be established for each virtual environment. I still believe that's important to understand, and the current article and PEP 405 don't cover it successfully, in my view.

----------
resolution: fixed -> 
status: closed -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Sat Sep  7 00:29:11 2013
From: report at bugs.python.org (R. David Murray)
Date: Fri, 06 Sep 2013 22:29:11 +0000
Subject: [docs] [issue18939] Venv docs regarding original python install
In-Reply-To: <1378418560.94.0.0370764034466.issue18939@psf.upfronthosting.co.za>
Message-ID: <1378506551.37.0.640905921061.issue18939@psf.upfronthosting.co.za>


R. David Murray added the comment:

You have understood correctly, after reading the now-existing documentation.  Do you have a suggestion for how they could be further improved, given that they currently seem to convey accurate information?

For the "autonomy" question, as far as I know the only option that affects that is whether or not the installed Python's site-packages is included in sys.path or not, and I'm sure that is documented.  Perhaps you were confused by how trivial indeed "activation" is?

If there are other things you still don't understand, it would help if you could pose specific questions.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18939>
_______________________________________

From report at bugs.python.org  Sat Sep  7 04:46:26 2013
From: report at bugs.python.org (py.user)
Date: Sat, 07 Sep 2013 02:46:26 +0000
Subject: [docs] [issue18951] In unittest.TestCase.assertRegex change "re"
	and "regex"	to "r"
Message-ID: <1378521986.13.0.796704852763.issue18951@psf.upfronthosting.co.za>


New submission from py.user:

there is no direct link to table

look under link
http://docs.python.org/3/library/unittest.html#unittest.TestCase.assertWarnsRegex

----------
assignee: docs at python
components: Documentation
files: issue.diff
keywords: patch
messages: 197130
nosy: docs at python, py.user
priority: normal
severity: normal
status: open
title: In unittest.TestCase.assertRegex change "re" and "regex" to "r"
type: enhancement
versions: Python 3.3, Python 3.4
Added file: http://bugs.python.org/file31636/issue.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18951>
_______________________________________

From report at bugs.python.org  Sat Sep  7 04:53:42 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 02:53:42 +0000
Subject: [docs] [issue18908] Enum docs: sections leak out
In-Reply-To: <1378161600.59.0.237500625913.issue18908@psf.upfronthosting.co.za>
Message-ID: <3cX0ZY1t8mz7Ljb@mail.python.org>


Roundup Robot added the comment:

New changeset a55cbaf9a581 by Ethan Furman in branch 'default':
Close #18908: Keep Enum docs in their own section.  Patch by Elazar Gershuni.
http://hg.python.org/cpython/rev/a55cbaf9a581

----------
nosy: +python-dev
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18908>
_______________________________________

From report at bugs.python.org  Sat Sep  7 06:40:22 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Sat, 07 Sep 2013 04:40:22 +0000
Subject: [docs] [issue18953] Typo in NEWS about fixed format specifiers
	for	Py_ssize_t in debugging output in the _sre module
Message-ID: <1378528822.12.0.535842380939.issue18953@psf.upfronthosting.co.za>


New submission from Vajrasky Kok:

File Misc/NEWS, line 65 & 66:

- Issue #18672: Fixed format specifiers for Py_ssize_t in debugging output in
  the _sre moduel.

"moduel" => "module"

Related commit:
http://hg.python.org/cpython/rev/c41c68a18bb6

----------
assignee: docs at python
components: Documentation
messages: 197134
nosy: docs at python, serhiy.storchaka, vajrasky
priority: normal
severity: normal
status: open
title: Typo in NEWS about fixed format specifiers for Py_ssize_t in debugging output in the _sre module
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18953>
_______________________________________

From report at bugs.python.org  Sat Sep  7 06:48:08 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Sat, 07 Sep 2013 04:48:08 +0000
Subject: [docs] [issue18954] Grammatically incorrect sentences in
	Python/fileutils.c
Message-ID: <1378529288.44.0.552917798936.issue18954@psf.upfronthosting.co.za>


New submission from Vajrasky Kok:

In commit about "implementation of the PEP 446: file descriptors and file handles are now created non-inheritable", there are some grammatically incorrect sentences in Python/fileutils.c.

Please see the patch for details.

Related commit:
http://hg.python.org/cpython/rev/ef889c3d5dc6?revcount=240

----------
assignee: docs at python
components: Documentation
files: fix_typo_in_fileutils.patch
keywords: patch
messages: 197135
nosy: docs at python, haypo, vajrasky
priority: normal
severity: normal
status: open
title: Grammatically incorrect sentences in Python/fileutils.c
versions: Python 3.4
Added file: http://bugs.python.org/file31639/fix_typo_in_fileutils.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18954>
_______________________________________

From report at bugs.python.org  Sat Sep  7 06:56:33 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Sat, 07 Sep 2013 04:56:33 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
Message-ID: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>


New submission from Vajrasky Kok:

In Lib/importlib/util.py, the documentation is confusing me.

Line 42 & 43:

    If an exception is raised and the decorator created the module it is
    subsequently removed from sys.modules.

Is it supposed to be:

    "If an exception is raised and the decorator which created the module is
    subsequently removed from sys.modules." ?

----------
assignee: docs at python
components: Documentation
messages: 197136
nosy: docs at python, vajrasky
priority: normal
severity: normal
status: open
title: Confusing documentation in Lib/importlib/util.py
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Sat Sep  7 07:38:56 2013
From: report at bugs.python.org (Ben Finney)
Date: Sat, 07 Sep 2013 05:38:56 +0000
Subject: [docs] =?utf-8?q?=5Bissue18956=5D_Document_useful_functions_in_?=
 =?utf-8?b?4oCYcHlkb2PigJkgbW9kdWxl?=
Message-ID: <1378532336.08.0.216765249116.issue18956@psf.upfronthosting.co.za>


New submission from Ben Finney:

The library documentation for ?pydoc? expects that the ?pydoc? module will only ever be run as a command-line program. This ignores the general usefulness of several of the functions in that module when imported from the library.

The documentation should describe at least the following functions:

* pydoc.getdoc

* pydoc.synopsis

* pydoc.splitdoc

The following would be useful also:

* pydoc.classname

* pydoc.cram

* pydoc.allmethods

----------
assignee: docs at python
components: Documentation
messages: 197138
nosy: bignose, docs at python
priority: normal
severity: normal
status: open
title: Document useful functions in ?pydoc? module
type: enhancement
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18956>
_______________________________________

From report at bugs.python.org  Sat Sep  7 07:56:38 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Sep 2013 05:56:38 +0000
Subject: [docs] [issue18894] In unittest.TestResult.failures remove
	deprecated fail*	methods
In-Reply-To: <1377966174.08.0.355322542495.issue18894@psf.upfronthosting.co.za>
Message-ID: <1378533398.01.0.426742825743.issue18894@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
nosy: +ezio.melotti, michael.foord

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18894>
_______________________________________

From report at bugs.python.org  Sat Sep  7 07:58:24 2013
From: report at bugs.python.org (Berker Peksag)
Date: Sat, 07 Sep 2013 05:58:24 +0000
Subject: [docs] =?utf-8?q?=5Bissue18956=5D_Document_useful_functions_in_?=
 =?utf-8?b?4oCYcHlkb2PigJkgbW9kdWxl?=
In-Reply-To: <1378532336.08.0.216765249116.issue18956@psf.upfronthosting.co.za>
Message-ID: <1378533504.92.0.722929443474.issue18956@psf.upfronthosting.co.za>


Berker Peksag added the comment:

Looks like duplicate of issue 7798.

> * pydoc.getdoc

http://docs.python.org/3.4/library/inspect.html#inspect.getdoc

> * pydoc.splitdoc

See issue 12916 for inspect.splitdoc.

> * pydoc.cram

This was rejected in issue 12914.

> * pydoc.allmethods

This was rejected in issue 12917.

----------
nosy: +berker.peksag
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18956>
_______________________________________

From report at bugs.python.org  Sat Sep  7 08:52:45 2013
From: report at bugs.python.org (Eric Snow)
Date: Sat, 07 Sep 2013 06:52:45 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
In-Reply-To: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>
Message-ID: <1378536765.91.0.975032469842.issue18955@psf.upfronthosting.co.za>


Eric Snow added the comment:

It is the module that gets removed.  I suppose it could say, "...created the module, then that module is subsequently...".  Would that help?

----------
nosy: +eric.snow

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Sat Sep  7 10:37:56 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 08:37:56 +0000
Subject: [docs] [issue18954] Grammatically incorrect sentences in
	Python/fileutils.c
In-Reply-To: <1378529288.44.0.552917798936.issue18954@psf.upfronthosting.co.za>
Message-ID: <3cX8Cl54CXz7Ljg@mail.python.org>


Roundup Robot added the comment:

New changeset 98f82b124c7d by Victor Stinner in branch 'default':
Close #18954: Fix some typo in fileutils.c comments
http://hg.python.org/cpython/rev/98f82b124c7d

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18954>
_______________________________________

From report at bugs.python.org  Sat Sep  7 10:38:21 2013
From: report at bugs.python.org (STINNER Victor)
Date: Sat, 07 Sep 2013 08:38:21 +0000
Subject: [docs] [issue18954] Grammatically incorrect sentences in
	Python/fileutils.c
In-Reply-To: <1378529288.44.0.552917798936.issue18954@psf.upfronthosting.co.za>
Message-ID: <1378543101.03.0.79667317366.issue18954@psf.upfronthosting.co.za>


STINNER Victor added the comment:

Thanks for the report! Don't hesitate to report other grammar issues ;-)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18954>
_______________________________________

From report at bugs.python.org  Sat Sep  7 12:47:00 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Sat, 07 Sep 2013 10:47:00 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
In-Reply-To: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>
Message-ID: <1378550820.01.0.918318442342.issue18955@psf.upfronthosting.co.za>


Vajrasky Kok added the comment:

That would help.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Sat Sep  7 14:20:33 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 12:20:33 +0000
Subject: [docs] [issue18894] In unittest.TestResult.failures remove
	deprecated fail*	methods
In-Reply-To: <1377966174.08.0.355322542495.issue18894@psf.upfronthosting.co.za>
Message-ID: <3cXF8Y2dsSz7LkG@mail.python.org>


Roundup Robot added the comment:

New changeset c391c30fee99 by Ezio Melotti in branch '2.7':
#18894: remove mention of deprecated fail* methods.
http://hg.python.org/cpython/rev/c391c30fee99

New changeset c3a2c0504960 by Ezio Melotti in branch '3.3':
#18894: remove mention of deprecated fail* methods.
http://hg.python.org/cpython/rev/c3a2c0504960

New changeset 5fbb01033a08 by Ezio Melotti in branch 'default':
#18894: merge with 3.3.
http://hg.python.org/cpython/rev/5fbb01033a08

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18894>
_______________________________________

From report at bugs.python.org  Sat Sep  7 14:21:24 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sat, 07 Sep 2013 12:21:24 +0000
Subject: [docs] [issue18894] In unittest.TestResult.failures remove
	deprecated fail*	methods
In-Reply-To: <1377966174.08.0.355322542495.issue18894@psf.upfronthosting.co.za>
Message-ID: <1378556484.16.0.362102169137.issue18894@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

Fixed, thanks for the report and the patch!

----------
assignee: docs at python -> ezio.melotti
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
versions: +Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18894>
_______________________________________

From report at bugs.python.org  Sat Sep  7 14:24:27 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 12:24:27 +0000
Subject: [docs] [issue18895] In unittest.TestResult.addError split the
	sentence
In-Reply-To: <1377966366.86.0.69110585984.issue18895@psf.upfronthosting.co.za>
Message-ID: <3cXFF63X3mz7LkG@mail.python.org>


Roundup Robot added the comment:

New changeset 523cfc78847c by Ezio Melotti in branch '2.7':
#18895: split a sentence in unittest docs.
http://hg.python.org/cpython/rev/523cfc78847c

New changeset dd669daad7de by Ezio Melotti in branch '3.3':
#18895: split a sentence in unittest docs.
http://hg.python.org/cpython/rev/dd669daad7de

New changeset 1043cc2cb0ff by Ezio Melotti in branch 'default':
#18895: merge with 3.3.
http://hg.python.org/cpython/rev/1043cc2cb0ff

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18895>
_______________________________________

From report at bugs.python.org  Sat Sep  7 14:24:49 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sat, 07 Sep 2013 12:24:49 +0000
Subject: [docs] [issue18895] In unittest.TestResult.addError split the
	sentence
In-Reply-To: <1377966366.86.0.69110585984.issue18895@psf.upfronthosting.co.za>
Message-ID: <1378556689.5.0.981458901862.issue18895@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

Fixed, thanks for the report and the patch!

----------
assignee: docs at python -> ezio.melotti
nosy: +ezio.melotti
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
versions: +Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18895>
_______________________________________

From report at bugs.python.org  Sat Sep  7 14:28:35 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sat, 07 Sep 2013 12:28:35 +0000
Subject: [docs] [issue18918] help('FILES') finds no documentation
In-Reply-To: <1378269620.52.0.763555902483.issue18918@psf.upfronthosting.co.za>
Message-ID: <1378556915.95.0.209759238593.issue18918@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
keywords: +easy
nosy: +ezio.melotti
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18918>
_______________________________________

From report at bugs.python.org  Sat Sep  7 15:09:22 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Sat, 07 Sep 2013 13:09:22 +0000
Subject: [docs] [issue18959] Create a "Superseded modules" section in
	standard	library ToC
Message-ID: <1378559362.61.0.726437189184.issue18959@psf.upfronthosting.co.za>


New submission from Nick Coghlan:

As discussed at the language summit earlier this year [1], it isn't alway easy to tell when glancing through the standard library docs which modules are merely hanging around because removing them would break backwards compatibility.

However, after reviewing the current ToC, we currently appear to only have two genuinely superseded modules: optparse (superseded by argparse) and imp (superseded by importlib).

Other cases where different modules touch on the same area are high level/low level splits (e.g. select vs selectors), or ones where the alternate modules are offering compatibility with different styles of API (e.g. etree vs DOM for XML, getopt vs argparse).

In future, asyncore/asynchat will hopefully be superseded by the PEP 3156 code (as "concurrent.events" or similar) and would also be moved under the new heading.

Marking as "easy" since the mechanics of the patch should be pretty simple: create a new heading and move the references to optparse and imp from their current locations.

[1] http://python-notes.boredomandlaziness.org/en/latest/conferences/pyconus2013/20130313-language-summit.html#legacy-modules

(I thought I had already created a bug for this, but can't find it, so I've created this new one. If I did already create an issue, we can close it as a duplicate and keep this one.)

----------
assignee: docs at python
components: Documentation
keywords: easy
messages: 197154
nosy: docs at python, ncoghlan
priority: normal
severity: normal
stage: needs patch
status: open
title: Create a "Superseded modules" section in standard library ToC
type: enhancement
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18959>
_______________________________________

From report at bugs.python.org  Sat Sep  7 16:05:04 2013
From: report at bugs.python.org (Hynek Schlawack)
Date: Sat, 07 Sep 2013 14:05:04 +0000
Subject: [docs] [issue18959] Create a "Superseded modules" section in
	standard	library ToC
In-Reply-To: <1378559362.61.0.726437189184.issue18959@psf.upfronthosting.co.za>
Message-ID: <1378562704.46.0.714709173123.issue18959@psf.upfronthosting.co.za>


Changes by Hynek Schlawack <hs at ox.cx>:


----------
nosy: +hynek

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18959>
_______________________________________

From report at bugs.python.org  Sat Sep  7 17:01:46 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Sat, 07 Sep 2013 15:01:46 +0000
Subject: [docs] [issue18958] Exception('No JSON object could be decoded')
	when	parsing a valid JSON
In-Reply-To: <1378557195.07.0.581794298686.issue18958@psf.upfronthosting.co.za>
Message-ID: <1378566106.15.0.262297725648.issue18958@psf.upfronthosting.co.za>


Nick Coghlan added the comment:

Switching to a docs bug - this won't be fixed in 2.7, but it should probably be documented as a limitation.

----------
assignee:  -> docs at python
components: +Documentation -Extension Modules
nosy: +docs at python, ncoghlan
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18958>
_______________________________________

From report at bugs.python.org  Sat Sep  7 20:30:15 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 18:30:15 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <3cXPMB3CYgz7LjM@mail.python.org>


Roundup Robot added the comment:

New changeset d5c5ac33b9a1 by Senthil Kumaran in branch '2.7':
os.isatty is not Unix only. Correct the wrong documentation.
http://hg.python.org/cpython/rev/d5c5ac33b9a1

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sat Sep  7 20:31:21 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sat, 07 Sep 2013 18:31:21 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1378578681.07.0.793751651121.issue18553@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

I have corrected the documentation. Thanks for raising this issue, anatoly techtonik.

----------
nosy: +orsenthil
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sat Sep  7 21:31:43 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sat, 07 Sep 2013 19:31:43 +0000
Subject: [docs] [issue18800] Document Fraction's numerator and denominator
	properties
In-Reply-To: <1377104746.66.0.571132107535.issue18800@psf.upfronthosting.co.za>
Message-ID: <1378582303.59.0.265728829091.issue18800@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

How does this simple patch sound?

----------
keywords: +patch
nosy: +orsenthil
Added file: http://bugs.python.org/file31651/18800.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18800>
_______________________________________

From report at bugs.python.org  Sat Sep  7 23:13:20 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 07 Sep 2013 21:13:20 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <3cXSzM4nlGz7Ll3@mail.python.org>


Roundup Robot added the comment:

New changeset a723adeb1f47 by Senthil Kumaran in branch '3.3':
Fix License URL display and add test to check for license url presence.
http://hg.python.org/cpython/rev/a723adeb1f47

New changeset 12aaf64feca2 by Senthil Kumaran in branch 'default':
merge from 3.3
http://hg.python.org/cpython/rev/12aaf64feca2

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep  7 23:16:06 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sat, 07 Sep 2013 21:16:06 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1378588566.39.0.6009495125.issue18206@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Fixed in the 3.3 and 3.4.

3.3 - changeset a723adeb1f47
3.4 - changeset 12aaf64feca2
3.4 - (Fixed a merge conflict) changeset 6ecdf2b3192b

----------
nosy: +orsenthil
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sun Sep  8 02:52:47 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 08 Sep 2013 00:52:47 +0000
Subject: [docs] [issue18033] Example for Profile Module shows incorrect
	method
In-Reply-To: <1369235558.14.0.532987051887.issue18033@psf.upfronthosting.co.za>
Message-ID: <3cXYrX5kLWz7LjX@mail.python.org>


Roundup Robot added the comment:

New changeset 93018d47793f by Senthil Kumaran in branch '2.7':
Correct Profile class usage example. Addresses issue #18033 .
http://hg.python.org/cpython/rev/93018d47793f

New changeset ab4d3ccb92e6 by Senthil Kumaran in branch '3.3':
Correct Profile class usage example. Addresses issue #18033.
http://hg.python.org/cpython/rev/ab4d3ccb92e6

New changeset 88182b388bae by Senthil Kumaran in branch 'default':
merge from 3.3
http://hg.python.org/cpython/rev/88182b388bae

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18033>
_______________________________________

From report at bugs.python.org  Sun Sep  8 02:53:55 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sun, 08 Sep 2013 00:53:55 +0000
Subject: [docs] [issue18033] Example for Profile Module shows incorrect
	method
In-Reply-To: <1369235558.14.0.532987051887.issue18033@psf.upfronthosting.co.za>
Message-ID: <1378601635.25.0.0324123635186.issue18033@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

I consolidated the patches and example and have committed them to 2.7, 3.3 and 3.4. Thanks for your contributions.

----------
nosy: +orsenthil
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18033>
_______________________________________

From report at bugs.python.org  Sun Sep  8 05:34:23 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 08 Sep 2013 03:34:23 +0000
Subject: [docs] [issue14971] (unittest) loadTestsFromName does not work on
	method	with a decorator
In-Reply-To: <1338490939.51.0.536223048687.issue14971@psf.upfronthosting.co.za>
Message-ID: <3cXdR26FQNz7LjY@mail.python.org>


Roundup Robot added the comment:

New changeset 78a5de507f19 by Michael Foord in branch '2.7':
Closes issue 14971.
http://hg.python.org/cpython/rev/78a5de507f19

----------
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue14971>
_______________________________________

From report at bugs.python.org  Sun Sep  8 08:20:15 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 08 Sep 2013 06:20:15 +0000
Subject: [docs] [issue18438] Obsolete url in comment inside decimal module
In-Reply-To: <1373686911.48.0.750703855786.issue18438@psf.upfronthosting.co.za>
Message-ID: <3cXj6Q1xnmz7LjW@mail.python.org>


Roundup Robot added the comment:

New changeset 44ed0cd3dc6d by Senthil Kumaran in branch '2.7':
Fix the dead link of IEEE_854-1987 standard with the Wikipedia entry.
http://hg.python.org/cpython/rev/44ed0cd3dc6d

New changeset 0eef1670f316 by Senthil Kumaran in branch '3.3':
Fix the dead link of IEEE_854-1987 standard with the Wikipedia entry.
http://hg.python.org/cpython/rev/0eef1670f316

New changeset 44fa59286012 by Senthil Kumaran in branch 'default':
merge from 3.3
http://hg.python.org/cpython/rev/44fa59286012

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18438>
_______________________________________

From report at bugs.python.org  Sun Sep  8 08:21:09 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sun, 08 Sep 2013 06:21:09 +0000
Subject: [docs] [issue18438] Obsolete url in comment inside decimal module
In-Reply-To: <1373686911.48.0.750703855786.issue18438@psf.upfronthosting.co.za>
Message-ID: <1378621269.08.0.689448715937.issue18438@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Fixed that in 2.7,3.3 and 3.4

----------
nosy: +orsenthil
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
versions: +Python 2.7, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18438>
_______________________________________

From report at bugs.python.org  Sun Sep  8 16:53:49 2013
From: report at bugs.python.org (Serhiy Storchaka)
Date: Sun, 08 Sep 2013 14:53:49 +0000
Subject: [docs] [issue18972] Use argparse in email example scripts
Message-ID: <1378652028.96.0.621116344908.issue18972@psf.upfronthosting.co.za>


New submission from Serhiy Storchaka:

Here is a patch which replaces optparse to argparse in the Doc/includes/email-dir.py and Doc/includes/email-unpack.py scripts.

----------
assignee: docs at python
components: Documentation, email
files: email_examples_argparse.patch
keywords: patch
messages: 197263
nosy: barry, docs at python, r.david.murray, serhiy.storchaka
priority: normal
severity: normal
stage: patch review
status: open
title: Use argparse in email example scripts
type: enhancement
versions: Python 3.4
Added file: http://bugs.python.org/file31666/email_examples_argparse.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18972>
_______________________________________

From report at bugs.python.org  Sun Sep  8 19:45:41 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 08 Sep 2013 17:45:41 +0000
Subject: [docs] [issue18953] Typo in NEWS about fixed format specifiers
	for	Py_ssize_t in debugging output in the _sre module
In-Reply-To: <1378528822.12.0.535842380939.issue18953@psf.upfronthosting.co.za>
Message-ID: <3cY0KJ48K9zSYh@mail.python.org>


Roundup Robot added the comment:

New changeset c08e92529f62 by Serhiy Storchaka in branch '3.3':
Fix a typo. (closes #18953)
http://hg.python.org/cpython/rev/c08e92529f62

New changeset 9dc5bdab157e by Serhiy Storchaka in branch 'default':
Fix a typo. (closes #18953)
http://hg.python.org/cpython/rev/9dc5bdab157e

New changeset 6ecdf5de6252 by Serhiy Storchaka in branch '2.7':
Fix a typo. (closes #18953)
http://hg.python.org/cpython/rev/6ecdf5de6252

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18953>
_______________________________________

From report at bugs.python.org  Sun Sep  8 19:50:11 2013
From: report at bugs.python.org (Serhiy Storchaka)
Date: Sun, 08 Sep 2013 17:50:11 +0000
Subject: [docs] [issue18953] Typo in NEWS about fixed format specifiers
	for	Py_ssize_t in debugging output in the _sre module
In-Reply-To: <1378528822.12.0.535842380939.issue18953@psf.upfronthosting.co.za>
Message-ID: <1378662611.39.0.62578589165.issue18953@psf.upfronthosting.co.za>


Serhiy Storchaka added the comment:

Thank you Vajrasky. Actually there was no need to open a new issue for such minor bug. You can report on the same issue which caused this bug. I'm afraid there are a lot of more grave syntax and grammatic errors in my Misc/NEWS entries.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18953>
_______________________________________

From report at bugs.python.org  Sun Sep  8 21:16:26 2013
From: report at bugs.python.org (Elazar Gershuni)
Date: Sun, 08 Sep 2013 19:16:26 +0000
Subject: [docs] [issue18980] Docs: enum - ReST format
Message-ID: <1378667786.26.0.0622956462221.issue18980@psf.upfronthosting.co.za>


New submission from Elazar Gershuni:

in http://docs.python.org/3.4/library/enum.html :
"..note: Nomenclature"
and 
".:meth:__format__"

visible in the html.

----------
assignee: docs at python
components: Documentation
files: enum_minor.patch
keywords: patch
messages: 197312
nosy: docs at python, elazar
priority: normal
severity: normal
status: open
title: Docs: enum - ReST format
versions: Python 3.4
Added file: http://bugs.python.org/file31682/enum_minor.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18980>
_______________________________________

From report at bugs.python.org  Sun Sep  8 22:55:41 2013
From: report at bugs.python.org (Anoop Thomas Mathew)
Date: Sun, 08 Sep 2013 20:55:41 +0000
Subject: [docs] [issue18981] Typo in the ctypes tests
Message-ID: <1378673741.26.0.448771285371.issue18981@psf.upfronthosting.co.za>


New submission from Anoop Thomas Mathew:

Comment in the test_number.py in ctypes test hold a typo bug. Instead of superseeded, it should be superseded. Patch attached.

----------
assignee: docs at python
components: Documentation, Tests
files: ctypes_test_typo.patch
keywords: patch
messages: 197318
nosy: Anoop.Thomas.Mathew, docs at python
priority: normal
severity: normal
status: open
title: Typo in the ctypes tests
type: enhancement
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5
Added file: http://bugs.python.org/file31685/ctypes_test_typo.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18981>
_______________________________________

From report at bugs.python.org  Sun Sep  8 23:24:44 2013
From: report at bugs.python.org (Nikolaus Rath)
Date: Sun, 08 Sep 2013 21:24:44 +0000
Subject: [docs] [issue12704] Language Reference: Clarify behaviour of yield
	when	generator is not resumed
In-Reply-To: <1312654346.88.0.619161172388.issue12704@psf.upfronthosting.co.za>
Message-ID: <1378675484.07.0.133277491795.issue12704@psf.upfronthosting.co.za>


Nikolaus Rath added the comment:

I've attached an updated patch.

I agree with Tim that the docs on the yield expression are already very good, so instead of extending the yield statement documentation I have shortened it to instead reduce the overlap that already exists.

In the yield expression documentation, I have replaced :keyword:`yield` with an un-tagged "yield" (because the former results in a link to the yield statement) and added '.. or yield statement' to the parts that apply to both yield expressions and statements.

I have also added hyperlinks to the relevant descriptions of the generator methods.

----------
Added file: http://bugs.python.org/file31688/yield-docpatch.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12704>
_______________________________________

From report at bugs.python.org  Sun Sep  8 23:25:23 2013
From: report at bugs.python.org (Anoop Thomas Mathew)
Date: Sun, 08 Sep 2013 21:25:23 +0000
Subject: [docs] [issue18815] DOCUMENTATION: "mmap .close()" doesn't close
	the	underlying file
In-Reply-To: <1377231601.59.0.456805422296.issue18815@psf.upfronthosting.co.za>
Message-ID: <1378675523.31.0.904790444372.issue18815@psf.upfronthosting.co.za>


Anoop Thomas Mathew added the comment:

Made it explicit that close() will close only the mmap, and file will not be closed. Patch attached.

----------
keywords: +patch
nosy: +Anoop.Thomas.Mathew
Added file: http://bugs.python.org/file31689/mmap_close_documentation.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18815>
_______________________________________

From report at bugs.python.org  Mon Sep  9 02:57:50 2013
From: report at bugs.python.org (Madison May)
Date: Mon, 09 Sep 2013 00:57:50 +0000
Subject: [docs] [issue18800] Document Fraction's numerator and denominator
	properties
In-Reply-To: <1377104746.66.0.571132107535.issue18800@psf.upfronthosting.co.za>
Message-ID: <1378688270.18.0.229706225581.issue18800@psf.upfronthosting.co.za>


Madison May added the comment:

Simple and to the point.  Sounds good to me...

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18800>
_______________________________________

From report at bugs.python.org  Mon Sep  9 07:23:23 2013
From: report at bugs.python.org (Berker Peksag)
Date: Mon, 09 Sep 2013 05:23:23 +0000
Subject: [docs] [issue18980] Docs: enum - ReST format
In-Reply-To: <1378667786.26.0.0622956462221.issue18980@psf.upfronthosting.co.za>
Message-ID: <1378704203.5.0.117076888808.issue18980@psf.upfronthosting.co.za>


Changes by Berker Peksag <berker.peksag at gmail.com>:


----------
nosy: +ethan.furman

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18980>
_______________________________________

From report at bugs.python.org  Mon Sep  9 08:48:50 2013
From: report at bugs.python.org (Roundup Robot)
Date: Mon, 09 Sep 2013 06:48:50 +0000
Subject: [docs] [issue18980] Docs: enum - ReST format
In-Reply-To: <1378667786.26.0.0622956462221.issue18980@psf.upfronthosting.co.za>
Message-ID: <3cYKhx0Rxfz7LjV@mail.python.org>


Roundup Robot added the comment:

New changeset 0e05b07a6f84 by Ethan Furman in branch 'default':
Close #18980: Enum doc fixes.  Patch from Elazar Gershuni.
http://hg.python.org/cpython/rev/0e05b07a6f84

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18980>
_______________________________________

From report at bugs.python.org  Mon Sep  9 08:55:43 2013
From: report at bugs.python.org (Roundup Robot)
Date: Mon, 09 Sep 2013 06:55:43 +0000
Subject: [docs] [issue18301] In itertools.chain.from_iterable() there is no
	cls	argument
In-Reply-To: <1372186723.21.0.67533324157.issue18301@psf.upfronthosting.co.za>
Message-ID: <3cYKrt2mx3z7Lkb@mail.python.org>


Roundup Robot added the comment:

New changeset 29fa1f418796 by Raymond Hettinger in branch '3.3':
Issue 18301:  The classmethod decorator didn't fit well with the rough-equivalent example code.
http://hg.python.org/cpython/rev/29fa1f418796

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18301>
_______________________________________

From report at bugs.python.org  Mon Sep  9 08:57:17 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Mon, 09 Sep 2013 06:57:17 +0000
Subject: [docs] [issue18301] In itertools.chain.from_iterable() there is no
	cls	argument
In-Reply-To: <1372186723.21.0.67533324157.issue18301@psf.upfronthosting.co.za>
Message-ID: <1378709837.97.0.589184248747.issue18301@psf.upfronthosting.co.za>


Changes by Raymond Hettinger <raymond.hettinger at gmail.com>:


----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18301>
_______________________________________

From report at bugs.python.org  Mon Sep  9 09:34:57 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Mon, 09 Sep 2013 07:34:57 +0000
Subject: [docs] [issue18313] In itertools recipes repeatfunc() defines a
	non-keyword	argument as keyword
In-Reply-To: <1372309261.95.0.7034101172.issue18313@psf.upfronthosting.co.za>
Message-ID: <1378712097.01.0.826633077192.issue18313@psf.upfronthosting.co.za>


Raymond Hettinger added the comment:

All of the proposed variants have their own issues.  

For example, the keyword-argument variant behaves badly if the user leaves off the keyword:

  >>> list(repeatfunc(ord, 'A', times=3))
  [65, 65, 65]
  >>> list(repeatfunc(ord, 'A', 3))
  Traceback (most recent call last):
    File "<pyshell#12>", line 1, in <module>
      list(repeatfunc(ord, 'A', 3))
  TypeError: ord() takes exactly one argument (2 given)

I prefer to leave the recipe as is.  The primary purpose of the recipe is to illustrate how starmap() and repeat() can be used together.  Will that knowledge, a user can easily cobble together in-line code for either the finite version or the infinite iterable version.

----------
priority: normal -> low
resolution:  -> rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18313>
_______________________________________

From report at bugs.python.org  Mon Sep  9 12:35:20 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Mon, 09 Sep 2013 10:35:20 +0000
Subject: [docs] [issue18985] Improve the documentation in fcntl module
Message-ID: <1378722919.93.0.901392318122.issue18985@psf.upfronthosting.co.za>


New submission from Vajrasky Kok:

The attached patch fixed typos and improved the documentation to improve the clarity in Modules/fcntlmodule.c.

Please see the attached patch and feel free to disagree with the improvement.

----------
assignee: docs at python
components: Documentation
files: fix_documentation_on_fcntl_module.patch
keywords: patch
messages: 197358
nosy: docs at python, vajrasky
priority: normal
severity: normal
status: open
title: Improve the documentation in fcntl module
type: enhancement
versions: Python 3.4
Added file: http://bugs.python.org/file31695/fix_documentation_on_fcntl_module.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18985>
_______________________________________

From report at bugs.python.org  Tue Sep 10 04:58:28 2013
From: report at bugs.python.org (Roundup Robot)
Date: Tue, 10 Sep 2013 02:58:28 +0000
Subject: [docs] [issue18800] Document Fraction's numerator and denominator
	properties
In-Reply-To: <1377104746.66.0.571132107535.issue18800@psf.upfronthosting.co.za>
Message-ID: <3cYrXg5TpMz7LjV@mail.python.org>


Roundup Robot added the comment:

New changeset fe5c03fb0ff6 by Senthil Kumaran in branch '3.3':
Document Fraction's numerator and denominator properties.
http://hg.python.org/cpython/rev/fe5c03fb0ff6

New changeset 5fb700ca3fd5 by Senthil Kumaran in branch 'default':
merge from 3.3
http://hg.python.org/cpython/rev/5fb700ca3fd5

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18800>
_______________________________________

From report at bugs.python.org  Tue Sep 10 04:59:58 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Tue, 10 Sep 2013 02:59:58 +0000
Subject: [docs] [issue18800] Document Fraction's numerator and denominator
	properties
In-Reply-To: <1377104746.66.0.571132107535.issue18800@psf.upfronthosting.co.za>
Message-ID: <1378781998.63.0.381929678394.issue18800@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Fixed in applicable versions 3.3 and 3.4.

----------
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed
versions:  -Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18800>
_______________________________________

From report at bugs.python.org  Tue Sep 10 07:40:21 2013
From: report at bugs.python.org (Roundup Robot)
Date: Tue, 10 Sep 2013 05:40:21 +0000
Subject: [docs] [issue18815] DOCUMENTATION: "mmap .close()" doesn't close
	the	underlying file
In-Reply-To: <1377231601.59.0.456805422296.issue18815@psf.upfronthosting.co.za>
Message-ID: <3cYw7S3v0gz7LjZ@mail.python.org>


Roundup Robot added the comment:

New changeset 443d12b61e5b by Senthil Kumaran in branch '2.7':
Clarify mmap.close method  behavior.  Addresses issue  #18815
http://hg.python.org/cpython/rev/443d12b61e5b

New changeset 373907ca13e0 by Senthil Kumaran in branch '3.3':
Clarify mmap.close method  behavior.  Addresses issue  #18815
http://hg.python.org/cpython/rev/373907ca13e0

New changeset 377bd6e0f61c by Senthil Kumaran in branch 'default':
merge from 3.3
http://hg.python.org/cpython/rev/377bd6e0f61c

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18815>
_______________________________________

From report at bugs.python.org  Tue Sep 10 07:41:08 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Tue, 10 Sep 2013 05:41:08 +0000
Subject: [docs] [issue18815] DOCUMENTATION: "mmap .close()" doesn't close
	the	underlying file
In-Reply-To: <1377231601.59.0.456805422296.issue18815@psf.upfronthosting.co.za>
Message-ID: <1378791668.91.0.697711934137.issue18815@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

This is addressed. Thanks for the patch, Anoop.

----------
nosy: +orsenthil
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18815>
_______________________________________

From report at bugs.python.org  Tue Sep 10 22:59:16 2013
From: report at bugs.python.org (Arfrever Frehtes Taifersar Arahesis)
Date: Tue, 10 Sep 2013 20:59:16 +0000
Subject: [docs] [issue10977] Concrete object C API considered harmful to
	subclasses	of builtin types
In-Reply-To: <1295653779.62.0.836506069174.issue10977@psf.upfronthosting.co.za>
Message-ID: <1378846756.6.0.282323235769.issue10977@psf.upfronthosting.co.za>


Changes by Arfrever Frehtes Taifersar Arahesis <Arfrever.FTA at GMail.Com>:


----------
nosy: +Arfrever

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10977>
_______________________________________

From report at bugs.python.org  Wed Sep 11 17:45:35 2013
From: report at bugs.python.org (Roy Smith)
Date: Wed, 11 Sep 2013 15:45:35 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
Message-ID: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>


New submission from Roy Smith:

http://docs.python.org/2/library/unittest.html#assert-methods

The docs say, "The TestCase class provides a number of methods to check for and report failures, such as", and then when you scroll a couple of screens down, there's another list, "There are also other methods used to perform more specific checks, such as".  These should be merged into a single list.  There's nothing fundamentally different about the two lists and breaking them into two parts just makes it harder to find what you want.

----------
assignee: docs at python
components: Documentation
messages: 197492
nosy: docs at python, roysmith
priority: normal
severity: normal
status: open
title: UnitTest docs should have a single list of assertions
versions: Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Wed Sep 11 18:10:16 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Wed, 11 Sep 2013 16:10:16 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
In-Reply-To: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>
Message-ID: <1378915816.54.0.0360063061436.issue19006@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

> There's nothing fundamentally different about the two lists

I made that division because the ones in the first table are the most common and widely used, and are quite general too.
The second table contains assert methods about catching exceptions and warnings, and, while still common, they are different from the first group. 
The third table has additional assertions that are quite specific and not used too often, and many of these have been added later on.
There's also a fourth table with additional type-specific assertions, but they shouldn't be used directly.

Also note that the list of methods is different on 3.x, even though I kept the same division on all the branches.

> These should be merged into a single list.

Having a table with all the assert methods would indeed provide a better overview, but it would be quite a big table (25 assert methods on 3.4, excluding the type-specific ones) and might make navigation more difficult while scrolling through the methods.  Something could be done to make clear that there are other tables down below though (e.g. adding links or using sub-sections with an index).

----------
nosy: +ezio.melotti, michael.foord
type:  -> enhancement
versions: +Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Wed Sep 11 20:03:41 2013
From: report at bugs.python.org (purplezephyr)
Date: Wed, 11 Sep 2013 18:03:41 +0000
Subject: [docs] [issue11163] iter() documentation code doesn't work
In-Reply-To: <1297284045.4.0.795458647498.issue11163@psf.upfronthosting.co.za>
Message-ID: <1378922621.17.0.087051258962.issue11163@psf.upfronthosting.co.za>


purplezephyr added the comment:

This does not seem to have been changed in any version, per msg135246.  If it's not going to be replaced, there's another issue, which is that the link to readline() in the text is incorrect - it goes to the readline module, not file.readline().

----------
nosy: +purplezephyr

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11163>
_______________________________________

From report at bugs.python.org  Wed Sep 11 21:28:28 2013
From: report at bugs.python.org (Roy Smith)
Date: Wed, 11 Sep 2013 19:28:28 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
In-Reply-To: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>
Message-ID: <1378927708.68.0.536370814303.issue19006@psf.upfronthosting.co.za>


Roy Smith added the comment:

Adding a note that there are more methods in the tables below would be useful.  Otherwise, you assume you've seen them all when you've read the first table.

I agree that the assertions about exceptions and warnings belong in a different group, but I don't see any fundamental reason to put assertGreater in a different table from assertEqual.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Wed Sep 11 21:41:06 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Wed, 11 Sep 2013 19:41:06 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
In-Reply-To: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>
Message-ID: <1378928466.69.0.465481501704.issue19006@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

One reason is that if I list all those assert methods first and keep the assertRaises/Warns in a separate group, they will be pushed way down, and people might miss them.
I'll try to prepare a patch that adds links to the other tables and/or changes the wording to make it clear that there are more assert methods.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Wed Sep 11 21:47:47 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 11 Sep 2013 19:47:47 +0000
Subject: [docs] [issue11163] iter() documentation code doesn't work
In-Reply-To: <1297284045.4.0.795458647498.issue11163@psf.upfronthosting.co.za>
Message-ID: <1378928867.4.0.695390996409.issue11163@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

In the current 3.3.2 docs, 'STOP' has been replaced by '', so there is a change, and no infinite loop. However, this is still does not strike me as an example of 'useful' as 
  for line in iter(fp.readline, "STOP"): # is a bad version of
  for line in fp:
It does illustrate the behavior though.

----------
stage:  -> needs patch
versions: +Python 3.4 -Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11163>
_______________________________________

From report at bugs.python.org  Wed Sep 11 21:56:42 2013
From: report at bugs.python.org (Serhiy Storchaka)
Date: Wed, 11 Sep 2013 19:56:42 +0000
Subject: [docs] [issue18911] minidom does not encode correctly when
	calling	Document.writexml
In-Reply-To: <1378186619.58.0.930376227557.issue18911@psf.upfronthosting.co.za>
Message-ID: <1378929402.5.0.24817963699.issue18911@psf.upfronthosting.co.za>


Changes by Serhiy Storchaka <storchaka at gmail.com>:


----------
assignee:  -> docs at python
components: +Documentation
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18911>
_______________________________________

From report at bugs.python.org  Thu Sep 12 10:00:39 2013
From: report at bugs.python.org (Anoop Thomas Mathew)
Date: Thu, 12 Sep 2013 08:00:39 +0000
Subject: [docs] [issue18981] Typo in the ctypes tests
In-Reply-To: <1378673741.26.0.448771285371.issue18981@psf.upfronthosting.co.za>
Message-ID: <1378972839.08.0.481185082544.issue18981@psf.upfronthosting.co.za>


Changes by Anoop Thomas Mathew <atmb4u at gmail.com>:


----------
nosy: +amaury.forgeotdarc, belopolsky, meador.inge

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18981>
_______________________________________

From report at bugs.python.org  Fri Sep 13 06:27:34 2013
From: report at bugs.python.org (Serhiy Storchaka)
Date: Fri, 13 Sep 2013 04:27:34 +0000
Subject: [docs] [issue18744] pathological performance using tarfile
In-Reply-To: <1376544025.63.0.959353089302.issue18744@psf.upfronthosting.co.za>
Message-ID: <1379046454.18.0.890465710188.issue18744@psf.upfronthosting.co.za>


Changes by Serhiy Storchaka <storchaka at gmail.com>:


----------
nosy:  -serhiy.storchaka

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18744>
_______________________________________

From report at bugs.python.org  Fri Sep 13 14:33:24 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Fri, 13 Sep 2013 12:33:24 +0000
Subject: [docs] [issue18911] minidom does not encode correctly when
	calling	Document.writexml
In-Reply-To: <1378186619.58.0.930376227557.issue18911@psf.upfronthosting.co.za>
Message-ID: <1379075604.14.0.800264887775.issue18911@psf.upfronthosting.co.za>


Changes by Eli Bendersky <eliben at gmail.com>:


----------
nosy:  -eli.bendersky

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18911>
_______________________________________

From report at bugs.python.org  Fri Sep 13 19:07:22 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 13 Sep 2013 17:07:22 +0000
Subject: [docs] [issue18951] In unittest.TestCase.assertRegex change "re"
	and "regex"	to "r"
In-Reply-To: <1378521986.13.0.796704852763.issue18951@psf.upfronthosting.co.za>
Message-ID: <1379092042.58.0.229097034865.issue18951@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

[The information in titles, especially long titles that do not fit in the title box (on my system, at least) should be repeated in the opening message.]

The point of the patch is to use the same name for the same object in the two columns* and to use a single letter to be consistent with the rest of the table. I think the patch should be applied.

* Using 're' and 'regex' to mean the same object *is* confusing.

----------
nosy: +terry.reedy
stage:  -> commit review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18951>
_______________________________________

From report at bugs.python.org  Fri Sep 13 20:07:48 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 18:07:48 +0000
Subject: [docs] [issue18951] In unittest.TestCase.assertRegex change "re"
	and "regex"	to "r"
In-Reply-To: <1378521986.13.0.796704852763.issue18951@psf.upfronthosting.co.za>
Message-ID: <1379095668.33.0.111140695737.issue18951@psf.upfronthosting.co.za>


py.user added the comment:

ok, I will repeat patch contents in message by words to avoid guessing

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18951>
_______________________________________

From report at bugs.python.org  Fri Sep 13 20:41:49 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 13 Sep 2013 18:41:49 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
In-Reply-To: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>
Message-ID: <1379097709.09.0.543768436981.issue19006@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

I like the current division, but agree that
  The TestCase class provides a number of methods to check for and
  report failures, such as:

is slightly misleading. I would change it to
  The TestCase class provides a number of methods to check for and
  report failures. The most commonly used are:
  ...<table>
  More are listed in the Regex, Comparisons, and Type-specific tables.

where each of Regex, Comparisons, and Type-specific link to their respective tables. (Repaint the link names if you wish ;-).

----------
nosy: +terry.reedy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Fri Sep 13 20:46:42 2013
From: report at bugs.python.org (Roy Smith)
Date: Fri, 13 Sep 2013 18:46:42 +0000
Subject: [docs] [issue19006] UnitTest docs should have a single list of
	assertions
In-Reply-To: <1378914335.13.0.0543263347661.issue19006@psf.upfronthosting.co.za>
Message-ID: <1379098002.39.0.97451587751.issue19006@psf.upfronthosting.co.za>


Roy Smith added the comment:

The new text suggested by terry.reedy works for me.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________

From report at bugs.python.org  Fri Sep 13 21:13:44 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 19:13:44 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379099624.2.0.417494671082.issue18206@psf.upfronthosting.co.za>


py.user added the comment:

Senthil Kumaran changed the pattern

from: r'^See (http://www\.python\.org/[^/]+/license.html)$'
  to: r'^See (http://www\.python\.org/download/releases/[^/]+/license/)$'

test doesn't pass

[guest at localhost cpython]$ ./python
Python 3.4.0a2+ (default, Sep 14 2013, 05:56:46) 
[GCC 4.7.2 20121109 (Red Hat 4.7.2-8)] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> license()
See http://www.python.org/3.4/license.html
>>>


make test
...
[265/380/3] test_site
test test_site failed -- Traceback (most recent call last):
  File "/home/guest/tmp/tests/misc/git/example/cpython/Lib/test/test_site.py", line 416, in test_license_page
    self.assertIsNotNone(mo, msg='can\'t find appropriate url in license')
AssertionError: unexpectedly None : can't find appropriate url in license
...

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Fri Sep 13 21:20:41 2013
From: report at bugs.python.org (Roundup Robot)
Date: Fri, 13 Sep 2013 19:20:41 +0000
Subject: [docs] [issue18951] In unittest.TestCase.assertRegex change "re"
	and "regex"	to "r"
In-Reply-To: <1378521986.13.0.796704852763.issue18951@psf.upfronthosting.co.za>
Message-ID: <3cc6Bc222NzQwf@mail.python.org>


Roundup Robot added the comment:

New changeset 03e94f9884ce by Ezio Melotti in branch '3.3':
#18951: use consistent names in unittest docs.
http://hg.python.org/cpython/rev/03e94f9884ce

New changeset eb332e3dc303 by Ezio Melotti in branch 'default':
#18951: merge with 3.3.
http://hg.python.org/cpython/rev/eb332e3dc303

New changeset 6d8ff8c57d38 by Ezio Melotti in branch '2.7':
#18951: use consistent names in unittest docs.
http://hg.python.org/cpython/rev/6d8ff8c57d38

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18951>
_______________________________________

From report at bugs.python.org  Fri Sep 13 21:20:53 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 19:20:53 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379100053.21.0.104815807116.issue18206@psf.upfronthosting.co.za>


Changes by py.user <bugzilla-mail-box at yandex.ru>:


----------
status: closed -> pending

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Fri Sep 13 21:23:38 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 19:23:38 +0000
Subject: [docs] [issue18951] In unittest.TestCase.assertRegex change "re"
	and "regex"	to "r"
In-Reply-To: <1378521986.13.0.796704852763.issue18951@psf.upfronthosting.co.za>
Message-ID: <1379100218.05.0.30141902151.issue18951@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

Fixed, thanks for the report and the patch!
I also updated the table entry for assertRaisesRegex and assertWarnsRegex.
I avoid using "regex" instead of "re" or "r" to keep it short and avoid confusion with the re/regex modules.  The documentation of the methods uses "regex", but there it's OK.

----------
assignee: docs at python -> ezio.melotti
nosy: +ezio.melotti
resolution:  -> fixed
stage: commit review -> committed/rejected
status: open -> closed
versions: +Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18951>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:13:13 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 20:13:13 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
In-Reply-To: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>
Message-ID: <1379103193.89.0.992198114368.issue18955@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
nosy: +brett.cannon
type:  -> enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:15:16 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 20:15:16 +0000
Subject: [docs] [issue18958] Exception('No JSON object could be decoded')
	when	parsing a valid JSON
In-Reply-To: <1378557195.07.0.581794298686.issue18958@psf.upfronthosting.co.za>
Message-ID: <1379103316.02.0.48294786154.issue18958@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
keywords: +easy
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18958>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:28:45 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 20:28:45 +0000
Subject: [docs] [issue18959] Create a "Superseded modules" section in
	standard	library ToC
In-Reply-To: <1378559362.61.0.726437189184.issue18959@psf.upfronthosting.co.za>
Message-ID: <1379104125.66.0.095457685287.issue18959@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18959>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:52:33 2013
From: report at bugs.python.org (Roundup Robot)
Date: Fri, 13 Sep 2013 20:52:33 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
In-Reply-To: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>
Message-ID: <3cc8Dc6Ys7z7Lk0@mail.python.org>


Roundup Robot added the comment:

New changeset ecc18ec4a12e by Brett Cannon in branch 'default':
Issue #18955: clarify what is removed by importlib.util.module_for_loader.
http://hg.python.org/cpython/rev/ecc18ec4a12e

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:52:53 2013
From: report at bugs.python.org (Brett Cannon)
Date: Fri, 13 Sep 2013 20:52:53 +0000
Subject: [docs] [issue18955] Confusing documentation in Lib/importlib/util.py
In-Reply-To: <1378529793.43.0.614039652943.issue18955@psf.upfronthosting.co.za>
Message-ID: <1379105573.15.0.0746050055349.issue18955@psf.upfronthosting.co.za>


Changes by Brett Cannon <brett at python.org>:


----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18955>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:54:52 2013
From: report at bugs.python.org (Roundup Robot)
Date: Fri, 13 Sep 2013 20:54:52 +0000
Subject: [docs] [issue18981] Typo in the ctypes tests
In-Reply-To: <1378673741.26.0.448771285371.issue18981@psf.upfronthosting.co.za>
Message-ID: <3cc8HH3YZ3zMGY@mail.python.org>


Roundup Robot added the comment:

New changeset b90ba60c5029 by Ezio Melotti in branch '2.7':
#18981: fix a typo in a comment (noticed by Anoop Thomas Mathew).
http://hg.python.org/cpython/rev/b90ba60c5029

New changeset 9fcb9deb70f5 by Ezio Melotti in branch '3.3':
#18981: fix a typo in a comment (noticed by Anoop Thomas Mathew).
http://hg.python.org/cpython/rev/9fcb9deb70f5

New changeset dae3e64e1743 by Ezio Melotti in branch 'default':
#18981: merge with 3.3.
http://hg.python.org/cpython/rev/dae3e64e1743

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18981>
_______________________________________

From report at bugs.python.org  Fri Sep 13 22:55:25 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 20:55:25 +0000
Subject: [docs] [issue18981] Typo in the ctypes tests
In-Reply-To: <1378673741.26.0.448771285371.issue18981@psf.upfronthosting.co.za>
Message-ID: <1379105725.03.0.852371328739.issue18981@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

Fixed, thanks for the report and the patch!

----------
assignee: docs at python -> ezio.melotti
nosy: +ezio.melotti
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18981>
_______________________________________

From ezio.melotti at gmail.com  Fri Sep 13 23:10:07 2013
From: ezio.melotti at gmail.com (ezio.melotti at gmail.com)
Date: Fri, 13 Sep 2013 21:10:07 -0000
Subject: [docs] Improve the documentation in fcntl module (issue 18985)
Message-ID: <20130913211007.14603.95643@psf.upfronthosting.co.za>


http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c
File Modules/fcntlmodule.c (right):

http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c#newcode120
Modules/fcntlmodule.c:120: char buf[IOCTL_BUFSZ+1];  /* argument plus
NULL byte */
http://en.wikipedia.org/wiki/Null_character

http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c#newcode422
Modules/fcntlmodule.c:422: and ioctl() Unix routines.  File descriptors
can be obtained with the \n\
This sentence might be clearer.  Are they all Unix routines?  Are they
available on all systems except flock()?  On what systems is flock()
available?

http://bugs.python.org/review/18985/

From report at bugs.python.org  Fri Sep 13 23:10:24 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Fri, 13 Sep 2013 21:10:24 +0000
Subject: [docs] [issue18985] Improve the documentation in fcntl module
In-Reply-To: <1378722919.93.0.901392318122.issue18985@psf.upfronthosting.co.za>
Message-ID: <1379106624.35.0.171879223342.issue18985@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18985>
_______________________________________

From report at bugs.python.org  Fri Sep 13 23:13:42 2013
From: report at bugs.python.org (R. David Murray)
Date: Fri, 13 Sep 2013 21:13:42 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379106822.55.0.184028193578.issue18206@psf.upfronthosting.co.za>


R. David Murray added the comment:

The test needs to be fixed so that it runs even when the LICENSE file exists. (It is also missing the skip when the network resource is not asserted.)  I have a patched test, and a fix for the 3.4 problem, but I can't apply it because the 3.4.0 license file does not yet exist on the website.

On the other hand, this test could be a pain before the first alpha is released (the web URL doesn't exist yet), so perhaps the test also needs to special case that somehow.

----------
nosy: +larry
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 00:11:49 2013
From: report at bugs.python.org (STINNER Victor)
Date: Fri, 13 Sep 2013 22:11:49 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379110309.01.0.0736754822125.issue18553@psf.upfronthosting.co.za>


STINNER Victor added the comment:

Why only changing Python 2 documentation?

http://docs.python.org/dev/library/os.html#os.isatty
still mention "Availability: Unix."

----------
nosy: +haypo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sat Sep 14 00:42:03 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Fri, 13 Sep 2013 22:42:03 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379112123.88.0.0607517838197.issue18553@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

I had removed them in all. Something must have gone wrong if still present or I did a mistake.


changeset:   85594:678e3c0d2d99
parent:      85591:c116b658aede
parent:      85593:14ba90816930
user:        Senthil Kumaran <senthil at uthcode.com>
date:        Sat Sep 07 11:30:04 2013 -0700
files:       Doc/library/os.rst
description:
merge from 3.3

Removing the mention of os.isatty mention as Unix only
Correct the wrong documentation.


changeset:   85593:14ba90816930
branch:      3.3
parent:      85589:dd669daad7de
user:        Senthil Kumaran <senthil at uthcode.com>
date:        Sat Sep 07 11:28:58 2013 -0700
files:       Doc/library/os.rst
description:
Removing the mention of os.isatty mention as Unix only
Correct the wrong documentation.


changeset:   85592:d5c5ac33b9a1
branch:      2.7
parent:      85588:523cfc78847c
user:        Senthil Kumaran <senthil at uthcode.com>

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sat Sep 14 01:33:02 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 23:33:02 +0000
Subject: [docs] [issue18206] license url in site.py should always use X.Y.Z
	form of	version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379115182.31.0.751386200161.issue18206@psf.upfronthosting.co.za>


py.user added the comment:

R. David Murray wrote:

>It is also missing the skip when the network resource is not asserted.

How it connects, I copied from another python tests.
The test was skipped without network connection.

"support.requires('network')" ?

>the 3.4.0 license file does not yet exist on the website

http://www.python.org/download/releases/3.4.0/license/
opens

>The test needs to be fixed so that it runs even when the LICENSE file exists.

The fixture can rename it back and forth.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 01:34:40 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 23:34:40 +0000
Subject: [docs] [issue18206] The license url in site.py should always use
	X.Y.Z form	of version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379115280.93.0.939510596737.issue18206@psf.upfronthosting.co.za>


Changes by py.user <bugzilla-mail-box at yandex.ru>:


----------
title: license url in site.py should always use X.Y.Z form of version number -> The license url in site.py should always use X.Y.Z form of version number

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 01:38:32 2013
From: report at bugs.python.org (py.user)
Date: Fri, 13 Sep 2013 23:38:32 +0000
Subject: [docs] [issue18206] The license url in site.py should always use
	X.Y.Z form	of version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379115511.93.0.926136294236.issue18206@psf.upfronthosting.co.za>


py.user added the comment:

The patch needs to be compatible with version 2.7
Now there urllib.request is importing only.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 19:32:13 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 14 Sep 2013 17:32:13 +0000
Subject: [docs] [issue18206] The license url in site.py should always use
	X.Y.Z form	of version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <3ccgl031HQz7LkK@mail.python.org>


Roundup Robot added the comment:

New changeset 7c18b799841e by R David Murray in branch '3.3':
#18206: Fix test for existence of license URL.
http://hg.python.org/cpython/rev/7c18b799841e

New changeset 321c3c9cd1b5 by R David Murray in branch 'default':
Merge #18206: Fix test for existence of license URL.
http://hg.python.org/cpython/rev/321c3c9cd1b5

New changeset 9354325d2ee4 by R David Murray in branch 'default':
#18206: Re-fix license URL.
http://hg.python.org/cpython/rev/9354325d2ee4

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 19:38:39 2013
From: report at bugs.python.org (R. David Murray)
Date: Sat, 14 Sep 2013 17:38:39 +0000
Subject: [docs] [issue18206] The license url in site.py should always use
	X.Y.Z form	of version number
In-Reply-To: <1371162560.09.0.685782864566.issue18206@psf.upfronthosting.co.za>
Message-ID: <1379180319.27.0.394173290456.issue18206@psf.upfronthosting.co.za>


R. David Murray added the comment:

You are right, there was a further typo in the 3.4 URL that I missed.

Yes, requires_resource('network') is what I was referring to (though using transient_internet is also a very good idea :).  I also changed the urllib call to only do a HEAD request.  No need to rename the LICENSE file, I just pulled the info out of the data structure.  It's a white box test, but then so is parsing the "See" line at all, so I think it is acceptable.

(I wonder if it would be worthwhile to have transient_internet call requires_resource('network')?)

----------
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sat Sep 14 20:00:15 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Sat, 14 Sep 2013 18:00:15 +0000
Subject: [docs] [issue18206] The license url in site.py should always use
	X.Y.Z form	of version number
In-Reply-To: <1379180319.27.0.394173290456.issue18206@psf.upfronthosting.co.za>
Message-ID: <CAPOVWOT=CxAM7HGk_kzFOHRQqwZt7stDsqLUPKm6isKyKuU16Q@mail.gmail.com>


Senthil Kumaran added the comment:

Thanks for making these changes (and correcting some of my mistakes), RDM.
They are much better now.

On Sat, Sep 14, 2013 at 10:38 AM, R. David Murray <report at bugs.python.org>wrote:

>
> R. David Murray added the comment:
>
> You are right, there was a further typo in the 3.4 URL that I missed.
>
> Yes, requires_resource('network') is what I was referring to (though using
> transient_internet is also a very good idea :).  I also changed the urllib
> call to only do a HEAD request.  No need to rename the LICENSE file, I just
> pulled the info out of the data structure.  It's a white box test, but then
> so is parsing the "See" line at all, so I think it is acceptable.
>
> (I wonder if it would be worthwhile to have transient_internet call
> requires_resource('network')?)
>
> ----------
> status: open -> closed
>
> _______________________________________
> Python tracker <report at bugs.python.org>
> <http://bugs.python.org/issue18206>
> _______________________________________
>

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18206>
_______________________________________

From report at bugs.python.org  Sun Sep 15 05:59:06 2013
From: report at bugs.python.org (Anoop Thomas Mathew)
Date: Sun, 15 Sep 2013 03:59:06 +0000
Subject: [docs] [issue18958] Exception('No JSON object could be decoded')
	when	parsing a valid JSON
In-Reply-To: <1378557195.07.0.581794298686.issue18958@psf.upfronthosting.co.za>
Message-ID: <1379217546.54.0.380283164126.issue18958@psf.upfronthosting.co.za>


Anoop Thomas Mathew added the comment:

Patch for BOM signature documentation in json.loads

----------
keywords: +patch
nosy: +Anoop.Thomas.Mathew
Added file: http://bugs.python.org/file31764/json_BOM_signature_documentation.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18958>
_______________________________________

From report at bugs.python.org  Sun Sep 15 13:57:50 2013
From: report at bugs.python.org (Sye van der Veen)
Date: Sun, 15 Sep 2013 11:57:50 +0000
Subject: [docs] [issue19023] ctypes docs: Unimplemented and undocumented
	features
Message-ID: <1379246270.23.0.998338553474.issue19023@psf.upfronthosting.co.za>


New submission from Sye van der Veen:

In the ctypes documentation, there's mention of a BigEndianUnion/LittleEndianUnion that isn't actually implemented, and the "Arrays and pointers" section just reads "Not yet written".

The attached patch adds the (Big|Little)EndianUnion classes (with tests), finishes the Array/_Pointer class docs (and adds missing cases to the tests), and makes some stylistic improvements to docs.

The patch was made against default, but it's quite likely it could be back-ported all the way to Python 3.1.

----------
assignee: docs at python
components: Documentation, Tests, ctypes
hgrepos: 209
messages: 197764
nosy: docs at python, syeberman
priority: normal
severity: normal
status: open
title: ctypes docs: Unimplemented and undocumented features
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19023>
_______________________________________

From report at bugs.python.org  Sun Sep 15 13:58:47 2013
From: report at bugs.python.org (Sye van der Veen)
Date: Sun, 15 Sep 2013 11:58:47 +0000
Subject: [docs] [issue19023] ctypes docs: Unimplemented and undocumented
	features
In-Reply-To: <1379246270.23.0.998338553474.issue19023@psf.upfronthosting.co.za>
Message-ID: <1379246327.82.0.119677972025.issue19023@psf.upfronthosting.co.za>


Changes by Sye van der Veen <syeberman at gmail.com>:


----------
keywords: +patch
Added file: http://bugs.python.org/file31769/75843d82f6cf.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19023>
_______________________________________

From report at bugs.python.org  Sun Sep 15 15:18:38 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 15 Sep 2013 13:18:38 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
Message-ID: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

I'd say this is a critical documentation bug that leads to head bang when you try to figure out what does '*' in code means.

This bug is two fold:
1. Define a dedicated place in documentation for '*' operator with examples. I propose http://docs.python.org/3/library/stdtypes.html chapter with a name like "Special Operations" or "Function Argument Operations" or "Function Argument Operators"
 
2. Make '*', 'asterisk', 'splat', 'star' operator searchable
http://docs.python.org/3/search.html?q=*
http://docs.python.org/3/search.html?q=asterisk
http://docs.python.org/3/search.html?q=splat
http://docs.python.org/3/search.html?q=star+operator

Good?

References:
http://stackoverflow.com/questions/2322355/proper-name-for-python-operator
http://stackoverflow.com/questions/5239856/foggy-on-asterisk-in-python
http://stackoverflow.com/questions/2921847/python-once-and-for-all-what-does-the-star-operator-mean-in-python
http://stackoverflow.com/questions/287085/what-do-args-and-kwargs-mean
http://stackoverflow.com/search?q=[python]+%2Bkwargs+is%3Aquestion

----------
assignee: docs at python
components: Documentation
messages: 197772
nosy: docs at python, techtonik
priority: normal
severity: normal
status: open
title: Document asterisk (*), splat or star operator
type: crash
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 15 15:50:20 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 15 Sep 2013 13:50:20 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379253020.85.0.728933157407.issue19024@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

tag:easy

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 15 15:58:17 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sun, 15 Sep 2013 13:58:17 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379253497.33.0.203146002395.issue19024@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
keywords: +easy
nosy: +ezio.melotti
stage:  -> needs patch
type: crash -> enhancement
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Mon Sep 16 04:11:58 2013
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 16 Sep 2013 02:11:58 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379297518.53.0.430148629878.issue19024@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
Removed message: http://bugs.python.org/msg197774

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Mon Sep 16 04:26:28 2013
From: report at bugs.python.org (Madison May)
Date: Mon, 16 Sep 2013 02:26:28 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379298388.42.0.0573031594593.issue19024@psf.upfronthosting.co.za>


Madison May added the comment:

http://docs.python.org/3/tutorial/controlflow.html#arbitrary-argument-lists
http://docs.python.org/3/tutorial/controlflow.html#unpacking-argument-lists 

The above links do a so-so of explaining the splat operator, although I agree that the docs for '*' could be improved.

----------
nosy: +madison.may

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Mon Sep 16 09:00:54 2013
From: report at bugs.python.org (paul j3)
Date: Mon, 16 Sep 2013 07:00:54 +0000
Subject: [docs] [issue9694] argparse required arguments displayed under
	"optional	arguments"
In-Reply-To: <1282846759.11.0.900867962743.issue9694@psf.upfronthosting.co.za>
Message-ID: <1379314854.08.0.72186581312.issue9694@psf.upfronthosting.co.za>


Changes by paul j3 <ajipanca at gmail.com>:


----------
nosy: +paul.j3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9694>
_______________________________________

From ZerbeB at humgen.ucsf.edu  Tue Sep  3 22:33:58 2013
From: ZerbeB at humgen.ucsf.edu (Zerbe, Brandon)
Date: Tue, 3 Sep 2013 20:33:58 +0000
Subject: [docs] Cpython sys.version parser in platform.py bug and resolution?
Message-ID: <18D8F2D99B52764489A4808889E71CE323B34B56@ex05.net.ucsf.edu>

To whom this may concern;

I am contacting you in the hope that I may provide help to others by addressing a possible, very small bug (assuming I diagnosed and solved the issue correctly).  No need to contact me since I consider my solution as sufficient.

I ran into an exception today from a program running plaftorm.py using python version 2.7.5.  Here is the code in platform.py that produced the exception (line 1454)

match = _sys_version_parser.match(sys_version)
if match is None:
    raise ValueError(
        'failed to parse CPython sys.version: %s' %
        repr(sys_version))


This results from the following regular expression:

_sys_version_parser = re.compile(
    r'([\w.+]+)\s*'
    '\|[^|]*\|\s*' # version extra
    '\(#?([^,]+),\s*([\w ]+),\s*([\w :]+)\)\s*'
    '\[([^\]]+)\]?')

At least on my computer, CPython does not have "version extra".  So I simply removed the second part of the regular expression and put it into a new object:

_cpython_sys_version_parser = re.compile(
    r'([\w.+]+)\s*'
    '\(#?([^,]+),\s*([\w ]+),\s*([\w :]+)\)\s*'
    '\[([^\]]+)\]?')

I then called this object for cpython, and it appears to have worked (fingers crossed).

Thanks,

Brandon Zerbe
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130903/4d3f7279/attachment.html>

From mayerbw at ornl.gov  Thu Sep  5 19:50:39 2013
From: mayerbw at ornl.gov (Mayer, Benjamin W.)
Date: Thu, 5 Sep 2013 13:50:39 -0400
Subject: [docs] os.path.getctime
Message-ID: <CE4E3CAF.35191%mayerbw@ornl.gov>

The os.path.getctime documention is misleading for Unix. Inserting the word "inode" into the follow is more accurate description of what is happening:

Return the system's ctime which on some systems (like Unix) is the time of the last in ode change,?

Thank you,

Ben Mayer

From vishalcdac07 at gmail.com  Mon Sep  9 20:23:55 2013
From: vishalcdac07 at gmail.com (vishal yadav)
Date: Mon, 9 Sep 2013 23:53:55 +0530
Subject: [docs] [Python Documentation Bug] __next__() method or next()
 method for Iterator class
Message-ID: <CAB0cepEP2pku6wD=eyWctA7bacb5Vxw1uUgfW8qOfzNHiA9qSg@mail.gmail.com>

Dear python.org documentation team,

The method that should be defined under Iterator Class should be __next__()
or next().

Problem: In case __next__() method is defined python under user defined
Iterator class, interpreter gives following error:
*TypeError: instance has no next() method*

Resolution: The problem is resolved when __next__() is renamed to next().

PS: My version of python Python 2.7.3

Regards,
Vishal
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130909/53e473fe/attachment.html>

From report at bugs.python.org  Mon Sep 16 15:51:08 2013
From: report at bugs.python.org (Vajrasky Kok)
Date: Mon, 16 Sep 2013 13:51:08 +0000
Subject: [docs] [issue18985] Improve the documentation in fcntl module
In-Reply-To: <1378722919.93.0.901392318122.issue18985@psf.upfronthosting.co.za>
Message-ID: <1379339468.79.0.745822091747.issue18985@psf.upfronthosting.co.za>


Vajrasky Kok added the comment:

Updated patch based on Ezio's review. I reverted back the changes to Nul and module documentation (since it is not so clear whether we should categorize flock as Unix routine or not).

----------
Added file: http://bugs.python.org/file31795/fix_documentation_on_fcntl_module_v2.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18985>
_______________________________________

From report at bugs.python.org  Mon Sep 16 22:18:26 2013
From: report at bugs.python.org (Roundup Robot)
Date: Mon, 16 Sep 2013 20:18:26 +0000
Subject: [docs] =?utf-8?q?=5Bissue17003=5D_Unification_of_read=28=29=C2=A0?=
 =?utf-8?q?and_readline=28=29_argument_names?=
In-Reply-To: <1358698394.54.0.180835263252.issue17003@psf.upfronthosting.co.za>
Message-ID: <3cdzKs2vnqzS13@mail.python.org>


Roundup Robot added the comment:

New changeset 46c1c2b34e2b by Serhiy Storchaka in branch 'default':
Issue #17003: Unified the size argument names in the io module with common
http://hg.python.org/cpython/rev/46c1c2b34e2b

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17003>
_______________________________________

From report at bugs.python.org  Mon Sep 16 23:02:14 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Mon, 16 Sep 2013 21:02:14 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
Message-ID: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>


New submission from Tae-Wong SEO:

This patch fixes sort order in file Misc/ACKS.

----------
assignee: docs at python
components: Documentation
files: ACKS
messages: 197945
nosy: docs at python, taewong.seo
priority: normal
severity: normal
status: open
title: Fix sort order in Misc/ACKS.
type: enhancement
Added file: http://bugs.python.org/file31803/ACKS

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Mon Sep 16 23:08:36 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Mon, 16 Sep 2013 21:08:36 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379365716.2.0.437133735656.issue19038@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

The ? sorts correctly after the Z.
Have you changed anything else other than that?
(If you upload a diff file it's better)

----------
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Mon Sep 16 23:21:33 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Mon, 16 Sep 2013 21:21:33 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379366493.78.0.501007304523.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

Letter a-with-ring is used in Swedish, Danish, Norwegian, Finnish and several other languages.
You have accentuated some contributor names (for example: Bozon, Donmez and Niksic).
You want to make a diff file for this.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Tue Sep 17 08:32:52 2013
From: report at bugs.python.org (Georg Brandl)
Date: Tue, 17 Sep 2013 06:32:52 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379399572.56.0.688244964483.issue19038@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Please do not change the ordering of ? -- it is correct after Z, at least in Swedish, Danish and Norwegian.

If you want to sort German umlauts correctly, in lists of names they are treated as [aou]+e, so "L?wis" goes before "Lowe".

As for Aahz, he appears by that name alone and should not be changed.

It's Jean-Paul, not Jean-Pierre Calderone.  This change makes me wary of accepting any of your other changes.  How did you come to your spellings of the names?

If you do, please resubmit in diff form.

----------
nosy: +georg.brandl
status: open -> pending

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Tue Sep 17 08:51:46 2013
From: report at bugs.python.org (Arfrever Frehtes Taifersar Arahesis)
Date: Tue, 17 Sep 2013 06:51:46 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379400706.33.0.480992366806.issue19038@psf.upfronthosting.co.za>


Changes by Arfrever Frehtes Taifersar Arahesis <Arfrever.FTA at GMail.Com>:


----------
nosy: +Arfrever
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Tue Sep 17 08:52:07 2013
From: report at bugs.python.org (Arfrever Frehtes Taifersar Arahesis)
Date: Tue, 17 Sep 2013 06:52:07 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379400727.45.0.307540086549.issue19038@psf.upfronthosting.co.za>


Changes by Arfrever Frehtes Taifersar Arahesis <Arfrever.FTA at GMail.Com>:


----------
status: open -> pending

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Tue Sep 17 09:01:40 2013
From: report at bugs.python.org (Thomas Guettler)
Date: Tue, 17 Sep 2013 07:01:40 +0000
Subject: [docs] [issue19039] sphinx search, result sorting
Message-ID: <1379401300.31.0.855533984181.issue19039@psf.upfronthosting.co.za>


New submission from Thomas Guettler:

If you search for "printf" in the docs you get this result:

http://docs.python.org/3.3/search.html?q=printf&check_keywords=yes&area=default

Please have a look at the first results. I guess most people don't want to see docs about "PyOS_snprintf"

Most people want to see this: http://docs.python.org/3.3/library/stdtypes.html?highlight=printf#printf-style-string-formatting

The good page (stdtypes.html) is the fourth search result.
And this page is huge. Unfortunately the link from the search result does not link to the section, it links to the top of the page.

 Since "printf" is in the heading, sphinx should be able to create a link to the relevant section in this page (in this example #printf-style-string-formatting).


Thank you

----------
assignee: docs at python
components: Documentation
messages: 197963
nosy: docs at python, guettli
priority: normal
severity: normal
status: open
title: sphinx search, result sorting

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19039>
_______________________________________

From report at bugs.python.org  Tue Sep 17 09:58:42 2013
From: report at bugs.python.org (Georg Brandl)
Date: Tue, 17 Sep 2013 07:58:42 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379404722.26.0.509892548318.issue18553@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Senthil: your 3.3->default merge removed the Availability from fpathconf().

----------
nosy: +georg.brandl
status: closed -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Tue Sep 17 10:03:08 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Tue, 17 Sep 2013 08:03:08 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379404988.71.0.921134133815.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

You want to submit a diff file.
You are not signing contributor agreement.
Letter a-with-ring is also usd in transliteration of Avestan language.

----------
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Tue Sep 17 10:28:17 2013
From: report at bugs.python.org (Georg Brandl)
Date: Tue, 17 Sep 2013 08:28:17 +0000
Subject: [docs] [issue19023] ctypes docs: Unimplemented and undocumented
	features
In-Reply-To: <1379246270.23.0.998338553474.issue19023@psf.upfronthosting.co.za>
Message-ID: <1379406497.41.0.805268095439.issue19023@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Thanks for the patch! The amount of unrelated changes (mostly removing ">>>" empty prompts) makes this a bit hard to review.

Also, I don't think it is too important to link to the "ctypes" module from within the docs of ctypes :)

Please separate out the implementation of the Union classes into a separate patch.

The Array docs look good to me.  The _Pointer docs talk about "reading and writing the elements using standard subscript and slice accesses".  That is true for pointers pointing to arrays, but ".contents" should be mentioned as well.

----------
nosy: +georg.brandl

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19023>
_______________________________________

From report at bugs.python.org  Tue Sep 17 12:10:37 2013
From: report at bugs.python.org (Drekin)
Date: Tue, 17 Sep 2013 10:10:37 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
Message-ID: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>


New submission from Drekin:

I tried to implement an Enum variant OptionalEnum such that OptionalEnum(value) leaves value alone and returnes it (if there is no corresponding enum member) rather than raising ValueError. My use case is following: I'm trying to parse some keyboard layout related data. There is a table which maps virtual keys to unicode codepoints, however there are some special values which don't represent a codepoint but the fact that the key is a deadkey and more information is provided in the next table entry. Or that the key produces a ligature. So I wanted to define enums for those special values.

This brought me to the following naive approach:
class OptionalEnum(Enum):
    def __new__(cls, value):
        try:
            return super(cls, cls).__new__(cls, value)
        except ValueError:
            return value

This ends with a weird exception. As I ran through enum code I found out that there are actually two flavors of EnumSubclass.__new__. The first one is for precreating the enum members (during creation of EnumSubclass). This is the intended usage. The second flavor is what happens when EnumSubclass(value) is called later. This flavor is represented by Enum.__new__ which returns existing member corresponding to the value or raises ValueError. However this Enum.__new__ is rather special. It doesn't take place in the process of the first flavor, it is explicitly by-passed. On the other hand it is forced behavior of the second flavor since it is explicitly assigned to EnumSubclass.__new__. So there seems to be no way to customize the second flavor (as I tried in my use case).

So could the customization of the second flavor of __new__ be added? (One maybe naive solution would be to let user explicitly define __new_member__ rather than __new__ to customize the first flavor and leave __new__ for the second flavor.) Or could at least be done something with the exceptions produced when one tries to? (The exception in my case was 'TypeError: object() takes no parameters' and was result of having custom __new__ and hence use_args==True but having member_type==object and __new__ not creating member with _value_ attribute so object(*args) was called.)

In any case additional documentation on customizing __new__ could help. There are points like that one should avoid the pattern of falling back to super().__new__ since that is Enum.__new__ which is for something else. Also the custom __new__ should return an object with _value_ attribute or object() with some argument may be called which leads to uninformative exception.

----------
assignee: docs at python
components: Documentation, Library (Lib)
messages: 197979
nosy: Drekin, docs at python
priority: normal
severity: normal
status: open
title: Problems with overriding Enum.__new__
type: behavior
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Tue Sep 17 16:00:52 2013
From: report at bugs.python.org (Ethan Furman)
Date: Tue, 17 Sep 2013 14:00:52 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1379426452.12.0.410455342572.issue19040@psf.upfronthosting.co.za>


Changes by Ethan Furman <ethan at stoneleaf.us>:


----------
nosy: +ethan.furman

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Tue Sep 17 16:10:04 2013
From: report at bugs.python.org (R. David Murray)
Date: Tue, 17 Sep 2013 14:10:04 +0000
Subject: [docs] [issue19039] sphinx search, result sorting
In-Reply-To: <1379401300.31.0.855533984181.issue19039@psf.upfronthosting.co.za>
Message-ID: <1379427004.08.0.352579356563.issue19039@psf.upfronthosting.co.za>


R. David Murray added the comment:

This is a Sphinx issue and should be reported on the Sphinx tracker...although I think Sphinx uses a 3rd party tool for the sorting, so it might go back up even a level further :).  

I don't think there's any reason to keep this issue open here, but I'll leave that up to Georg.

----------
assignee: docs at python -> 
nosy: +georg.brandl, r.david.murray

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19039>
_______________________________________

From report at bugs.python.org  Tue Sep 17 16:48:23 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Tue, 17 Sep 2013 14:48:23 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379429302.99.0.29242541237.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

You want to add the packaging coordinator Laca (real name L?szl? P?ter in Hungarian) to Misc/ACKS.

And you want to add a bunch of real names from the python-bugs-list mailing list (from August 2007 to September 2013).

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 01:23:33 2013
From: report at bugs.python.org (Brian Curtin)
Date: Tue, 17 Sep 2013 23:23:33 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379460213.01.0.197338983262.issue19038@psf.upfronthosting.co.za>


Brian Curtin added the comment:

I don't believe we want to do those things. Changes should be in a diff file and limited to the minimum amount of required changes to fix your sort ordering bug - not adding people or changing the spelling of people's names.

----------
nosy: +brian.curtin
status: open -> pending

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 01:35:18 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Tue, 17 Sep 2013 23:35:18 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379460918.11.0.58431544143.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

You want to make diff file to get changes from the ACKS file.

----------
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 04:08:44 2013
From: report at bugs.python.org (Mike Hoy)
Date: Wed, 18 Sep 2013 02:08:44 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379470124.51.0.731876631612.issue19024@psf.upfronthosting.co.za>


Changes by Mike Hoy <mhoy09 at gmail.com>:


----------
nosy: +mikehoy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Wed Sep 18 04:25:31 2013
From: report at bugs.python.org (Mike Hoy)
Date: Wed, 18 Sep 2013 02:25:31 +0000
Subject: [docs] [issue18918] help('FILES') finds no documentation
In-Reply-To: <1378269620.52.0.763555902483.issue18918@psf.upfronthosting.co.za>
Message-ID: <1379471131.29.0.885173922171.issue18918@psf.upfronthosting.co.za>


Changes by Mike Hoy <mhoy09 at gmail.com>:


----------
nosy: +mikehoy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18918>
_______________________________________

From report at bugs.python.org  Wed Sep 18 04:31:18 2013
From: report at bugs.python.org (Mike Hoy)
Date: Wed, 18 Sep 2013 02:31:18 +0000
Subject: [docs] [issue18855] Inconsistent README filenames
In-Reply-To: <1377616570.1.0.108273179071.issue18855@psf.upfronthosting.co.za>
Message-ID: <1379471478.11.0.765414790595.issue18855@psf.upfronthosting.co.za>


Changes by Mike Hoy <mhoy09 at gmail.com>:


----------
nosy: +mikehoy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18855>
_______________________________________

From report at bugs.python.org  Wed Sep 18 10:29:11 2013
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Sep 2013 08:29:11 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379492951.32.0.361503551898.issue19038@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Well, it is customary for the patch submitter to make the diff.  This makes it much easier for us to review.

Closing for now; please note our suggestions and reopen/resubmit as a diff file if you feel like it.

----------
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 10:34:04 2013
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Sep 2013 08:34:04 +0000
Subject: [docs] [issue18855] Inconsistent README filenames
In-Reply-To: <1377616570.1.0.108273179071.issue18855@psf.upfronthosting.co.za>
Message-ID: <1379493244.75.0.271485605491.issue18855@psf.upfronthosting.co.za>


Georg Brandl added the comment:

AFAIR renaming the lowercased versions might lead to trouble with hg on case-insensitive file systems. Anyone know if that's still the case?

Otherwise README.txt is fine.  Although, Windows users will then complain about the Unix-style line endings because the files will be opened with Notepad by default :|

----------
nosy: +georg.brandl

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18855>
_______________________________________

From report at bugs.python.org  Wed Sep 18 10:52:56 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Wed, 18 Sep 2013 08:52:56 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379494376.4.0.142572859059.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

Your Gmail account tried to send spam for this account.

Be careful with this message. Many people marked similar messages as spam.

Open this bug and have someone made a diff file to fix sort order.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 11:05:54 2013
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Sep 2013 09:05:54 +0000
Subject: [docs] [issue19039] sphinx search, result sorting
In-Reply-To: <1379401300.31.0.855533984181.issue19039@psf.upfronthosting.co.za>
Message-ID: <1379495154.84.0.942041158434.issue19039@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Searching in headings is implemented in Sphinx 1.2 (soon to be released).  We'll switch to that version at least for 3.3 and 3.4 when it's out, so you will get the result for the heading there.

The PyOS_snprintf will still be the first result, since results in "object names" are always the first preference.  But the second preference will be heading names.

----------
resolution:  -> later
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19039>
_______________________________________

From report at bugs.python.org  Wed Sep 18 11:05:56 2013
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Sep 2013 09:05:56 +0000
Subject: [docs] [issue19039] sphinx search, result sorting
In-Reply-To: <1379401300.31.0.855533984181.issue19039@psf.upfronthosting.co.za>
Message-ID: <1379495156.06.0.659077498248.issue19039@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Searching in headings is implemented in Sphinx 1.2 (soon to be released).  We'll switch to that version at least for 3.3 and 3.4 when it's out, so you will get the result for the heading there.

The PyOS_snprintf will still be the first result, since results in "object names" are always the first preference.  But the second preference will be heading names.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19039>
_______________________________________

From report at bugs.python.org  Wed Sep 18 11:06:49 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Wed, 18 Sep 2013 09:06:49 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379495209.26.0.710542794395.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

New diff file to change Bozon's last name.

----------
keywords: +patch
status: closed -> pending
Added file: http://bugs.python.org/file31807/ACKS.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From srobertson at blackcreekisc.com  Tue Sep 10 15:21:03 2013
From: srobertson at blackcreekisc.com (Sterling Robertson)
Date: Tue, 10 Sep 2013 08:21:03 -0500
Subject: [docs] Bug / Room for Improvement
Message-ID: <000501ceae28$99b7d690$cd2783b0$@com>

In section 9.2.1 of the tutorial, at
http://docs.python.org/3/tutorial/classes.html, the sample program does not
work.  The following is what happens when someone tries to type it in (I'm
using IDLE for Python 3.3.2):

 

>>> def scope_test():

                def do_local():

                                spam = "local spam"

                def do_nonlocal():

                                nonlocal spam

                                

SyntaxError: no binding for nonlocal 'spam' found

 

This needs to be corrected, especially when you consider the poor
explanations and lack of clarity throughout these tutorials and especially
this chapter.  I'm a professional programmer, and I'm still having a hard
time following your tutorials.

 

One of the biggest issues is that you're trying to put too much detail into
too few words.  Many different facts are being thrown at absolute beginners
all at once, with very little elaboration.  Many of the details you're
trying to describe are not fully explained, causing critical gaps of
information.  You should do one of two things:

 

1)      Expand your tutorials and elaborate more fully on what it is you're
trying to communicate, making sure that every detail is completely explained
and well-defined.

2)      Remove many of the details that you're getting sidetracked on, and
re-invest that amount of space in the tutorials to more clearly explaining
the parts of the language that are more central and important for a beginner
who is studying the language for the first time.

 

Furthermore section 9.2 is using unorthodox terminology with little or no
explanation, and it's not very well-written in general.  This section
appears to be trying to explain a concept in overly complicated,
"beat-around-the-bush" wording, and it's not even doing that very well.  It
should be re-written from the ground up, and it should either use more
standard terminology, or if unorthodox terminology is a necessity, provide a
more thorough explanation of what that terminology means.  Even for
professional programmers, it is very hard to read and follow.

 

Please understand that I am not trying to be overly negative or critical,
but I do believe someone needs to go through the tutorial and look it over
for things like this.  Remember that some of the people reading this have no
previous programming experience, and when it's already difficult for
professionals to follow, it would be almost impossible for them.  Thank you.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130910/deffbe74/attachment-0001.html>

From vishalcdac07 at gmail.com  Wed Sep 11 14:56:14 2013
From: vishalcdac07 at gmail.com (vishal yadav)
Date: Wed, 11 Sep 2013 18:26:14 +0530
Subject: [docs] [Python Documentation Bug] __next__() method or next()
 method for Iterator class
In-Reply-To: <CAB0cepEP2pku6wD=eyWctA7bacb5Vxw1uUgfW8qOfzNHiA9qSg@mail.gmail.com>
References: <CAB0cepEP2pku6wD=eyWctA7bacb5Vxw1uUgfW8qOfzNHiA9qSg@mail.gmail.com>
Message-ID: <CAB0cepHYCX9zuBA3rsBhmSoN5bnYiCtt+bEHyo+mhevxaasqvA@mail.gmail.com>

Problem: Under section 10.11 Quality Control function 'average' returns
integer division causing doctest and unittest to fail.
Resolution: average function should return "float division".

Regards,
Vishal


On Mon, Sep 9, 2013 at 11:53 PM, vishal yadav <vishalcdac07 at gmail.com>wrote:

> Dear python.org documentation team,
>
> The method that should be defined under Iterator Class should be
> __next__() or next().
>
> Problem: In case __next__() method is defined python under user defined
> Iterator class, interpreter gives following error:
> *TypeError: instance has no next() method*
>
> Resolution: The problem is resolved when __next__() is renamed to next().
>
> PS: My version of python Python 2.7.3
>
> Regards,
> Vishal
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130911/2e80c79f/attachment-0001.html>

From vishalcdac07 at gmail.com  Thu Sep 12 20:23:45 2013
From: vishalcdac07 at gmail.com (vishal yadav)
Date: Thu, 12 Sep 2013 23:53:45 +0530
Subject: [docs] [Python Documentation Bug] __next__() method or next()
 method for Iterator class
In-Reply-To: <CAB0cepHYCX9zuBA3rsBhmSoN5bnYiCtt+bEHyo+mhevxaasqvA@mail.gmail.com>
References: <CAB0cepEP2pku6wD=eyWctA7bacb5Vxw1uUgfW8qOfzNHiA9qSg@mail.gmail.com>
 <CAB0cepHYCX9zuBA3rsBhmSoN5bnYiCtt+bEHyo+mhevxaasqvA@mail.gmail.com>
Message-ID: <CAB0cepG01iA-pRqfBJ34CqRBCg2+qK46DmtxtF2H72eegd1MsQ@mail.gmail.com>

Sorry! My mistake... I have been referring to wrong version of
documentation (3.2) while working with 2.7.

Regards,
Vishal


On Wed, Sep 11, 2013 at 6:26 PM, vishal yadav <vishalcdac07 at gmail.com>wrote:

> Problem: Under section 10.11 Quality Control function 'average' returns
> integer division causing doctest and unittest to fail.
> Resolution: average function should return "float division".
>
> Regards,
> Vishal
>
>
> On Mon, Sep 9, 2013 at 11:53 PM, vishal yadav <vishalcdac07 at gmail.com>wrote:
>
>> Dear python.org documentation team,
>>
>> The method that should be defined under Iterator Class should be
>> __next__() or next().
>>
>> Problem: In case __next__() method is defined python under user defined
>> Iterator class, interpreter gives following error:
>> *TypeError: instance has no next() method*
>>
>> Resolution: The problem is resolved when __next__() is renamed to next().
>>
>> PS: My version of python Python 2.7.3
>>
>> Regards,
>> Vishal
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130912/f15c43a8/attachment-0001.html>

From jkooker at gmail.com  Fri Sep 13 18:58:32 2013
From: jkooker at gmail.com (John Kooker)
Date: Fri, 13 Sep 2013 09:58:32 -0700
Subject: [docs] Small error in argparse documentation
Message-ID: <CAN6rOxgbREa7e85Bs2DtPQ2EjkzLL_vkX46s5x8LJUjXin4x=Q@mail.gmail.com>

Hey Python docs team,

I think I may have found a small error in the docs. The last example in the
argparse add_help section doesn't look correct. The dashes should be plus
signs.

http://docs.python.org/dev/library/argparse.html#add-help

Thanks for all your hard work! These docs are fantastic.

--john
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130913/ef7349e3/attachment-0001.html>

From ezyang at cs.stanford.edu  Sat Sep 14 06:07:41 2013
From: ezyang at cs.stanford.edu (Edward Z. Yang)
Date: Fri, 13 Sep 2013 21:07:41 -0700
Subject: [docs] Omit parens from hashlib.md5() in hmac
Message-ID: <1379131609-sup-3749@javelin>

Presently we have this text at http://docs.python.org/2/library/hmac.html:

    Return a new hmac object. If msg is present, the method call update(msg)
    is made. digestmod is the digest constructor or module for the HMAC
    object to use. It defaults to the hashlib.md5() constructor.

This text is misleading, as it suggests that the usage of the
digestmod param is:

    hmac.new(secret, msg, hashlib.sha256())

which is not right.

Cheers,
Edward

From sky.kok at speaklikeaking.com  Sun Sep 15 11:31:12 2013
From: sky.kok at speaklikeaking.com (sky.kok at speaklikeaking.com)
Date: Sun, 15 Sep 2013 09:31:12 -0000
Subject: [docs] Improve the documentation in fcntl module (issue 18985)
Message-ID: <20130915093112.5359.13593@psf.upfronthosting.co.za>

Reviewers: ezio.melotti,


http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c
File Modules/fcntlmodule.c (right):

http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c#newcode120
Modules/fcntlmodule.c:120: char buf[IOCTL_BUFSZ+1];  /* argument plus
NULL byte */
On 2013/09/13 23:10:07, ezio.melotti wrote:
> http://en.wikipedia.org/wiki/Null_character

Ah, sorry about that.

http://bugs.python.org/review/18985/diff/9247/Modules/fcntlmodule.c#newcode422
Modules/fcntlmodule.c:422: and ioctl() Unix routines.  File descriptors
can be obtained with the \n\
On 2013/09/13 23:10:07, ezio.melotti wrote:
> This sentence might be clearer.  Are they all Unix routines?  Are they
available
> on all systems except flock()?  On what systems is flock() available?

It is not clear why on some system flock is not available natively. But
the manual (http://linux.about.com/library/cmd/blcmdl2_flock.htm) and
the comment inside this file says:

A version of flock(2), possibly implemented in terms of fcntl(2),
appears on most Unices.

&

Perform the lock operation opt on file descriptor fd.  See the Unix \n\
manual page for flock(3) for details.  (On some systems, this function
is\n\
emulated using fcntl().)

Lockf is somewhat similar with flock.

On Linux, lockf() is just an interface on top of fcntl(2) locking.
       Many other systems implement lockf() in this way, but note that
       POSIX.1-2001 leaves the relationship between lockf() and fcntl(2)
       locks unspecified.

So in most (all?) cases, ioctl and fcntl are unix routines. But in most
(all?) cases, lockf is emulated around fcntl. And in some cases, flock
is emulated around fcntl, and in other cases, flock comes natively.



Please review this at http://bugs.python.org/review/18985/

Affected files:
  Modules/fcntlmodule.c


diff -r aff959a3ba13 Modules/fcntlmodule.c
--- a/Modules/fcntlmodule.c	Sun Sep 08 18:44:40 2013 -0500
+++ b/Modules/fcntlmodule.c	Mon Sep 09 18:21:53 2013 +0800
@@ -80,8 +80,8 @@
 "fcntl(fd, opt, [arg])\n\
 \n\
 Perform the requested operation on file descriptor fd.  The operation\n\
-is defined by op and is operating system dependent.  These constants are\n\
-available from the fcntl module.  The argument arg is optional, and\n\
+is defined by opt and is operating system dependent.  The possible values of\n\
+opt are available from the fcntl module.  The argument arg is optional, and\n\
 defaults to 0; it may be an int or a string.  If arg is given as a string,\n\
 the return value of fcntl is a string of that length, containing the\n\
 resulting value put in the arg buffer by the operating system.  The length\n\
@@ -104,7 +104,7 @@
        whereas the system expects it to be a 32bit bit field value
        regardless of it being passed as an int or unsigned long on
        various platforms.  See the termios.TIOCSWINSZ constant across
-       platforms for an example of thise.
+       platforms for an example of this.
 
        If any of the 64bit platforms ever decide to use more than 32bits
        in their unsigned long ioctl codes this will break and need
@@ -117,7 +117,7 @@
     char *str;
     Py_ssize_t len;
     int mutate_arg = 1;
-    char buf[IOCTL_BUFSZ+1];  /* argument plus NUL byte */
+    char buf[IOCTL_BUFSZ+1];  /* argument plus NULL byte */
 
     if (PyArg_ParseTuple(args, "O&Iw*|i:ioctl",
                          conv_descriptor, &fd, &code,
@@ -306,9 +306,9 @@
 }
 
 PyDoc_STRVAR(flock_doc,
-"flock(fd, operation)\n\
+"flock(fd, opt)\n\
 \n\
-Perform the lock operation op on file descriptor fd.  See the Unix \n\
+Perform the lock operation opt on file descriptor fd.  See the Unix \n\
 manual page for flock(3) for details.  (On some systems, this function is\n\
 emulated using fcntl().)");
 
@@ -418,9 +418,9 @@
 
 PyDoc_STRVAR(module_doc,
 "This module performs file control and I/O control on file \n\
-descriptors.  It is an interface to the fcntl() and ioctl() Unix\n\
-routines.  File descriptors can be obtained with the fileno() method of\n\
-a file or socket object.");
+descriptors.  It is an interface to the fcntl(), flock() (on some systems) \n\
+and ioctl() Unix routines.  File descriptors can be obtained with the \n\
+fileno() method of a file or socket object.");
 
 /* Module initialisation */
 



From JonPaul.Sullivan at hp.com  Mon Sep 16 12:59:51 2013
From: JonPaul.Sullivan at hp.com (Sullivan, Jon Paul)
Date: Mon, 16 Sep 2013 10:59:51 +0000
Subject: [docs] CSV nit-pick
Message-ID: <A5492763B7A1E640AEB5E1C05208B1F253FC2A8C@G9W0752.americas.hpqcorp.net>

The intro to the CSV module says there is no standard for a CSV file: http://docs.python.org/2/library/csv.html.

Although not an actual standard,  http://tools.ietf.org/html/rfc4180 defines the format of CSV files for the text/csv mime-type, and should likely be referenced and adhered to by the CSV code.

Thanks,
*: JonPaul.Sullivan at hp.com :) Cloud Services - @hpcloud
*: +353 (91) 75 4169

Postal Address: Hewlett-Packard Galway Limited, Ballybrit Business Park, Galway.
Registered Office: Hewlett-Packard Galway Limited, 63-74 Sir John Rogerson's Quay, Dublin 2.
Registered Number: 361933

The contents of this message and any attachments to it are confidential and may be legally privileged. If you have received this message in error you should delete it from your system immediately and advise the sender.

To any recipient of this message within HP, unless otherwise stated, you should consider this message and attachments as "HP CONFIDENTIAL".

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130916/4c6c2e65/attachment-0001.html>

From omri at everything.me  Mon Sep 16 14:08:14 2013
From: omri at everything.me (Omri Oren)
Date: Mon, 16 Sep 2013 15:08:14 +0300
Subject: [docs] Typo in urlparse documentation
Message-ID: <CAMVLGWT7rF3Bmn4K5XXPNB8E_V8_ndfDBaUdEo=ettNg7tzeZQ@mail.gmail.com>

Hi,

I believe the result of
   "urlparse('www.cwi.nl/%7Eguido/Python.html')"
in the docs page
   http://docs.python.org/2/library/urlparse.html
should contain
  "path='www.cwi.nl/%7Eguido/Python.html'"
instead of
  "path='www.cwi.nl*:80*/%7Eguido/Python.html'"

Cheers,
Omri

*Omri Oren*   Algorithm Engineer
<omri at everything.me>omri at everything.me <http://corp.everything.me/>
visit us at http://everything.me <http://corp.everything.me/>
<https://play.google.com/store/apps/details?id=me.everything.launcher&referrer=utm_source%3Devme%26utm_medium%3Demailsig>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130916/ab9f744f/attachment-0001.html>

From sergipuig at hotmail.com  Tue Sep 17 21:21:02 2013
From: sergipuig at hotmail.com (Sergi Puig Villaplana)
Date: Tue, 17 Sep 2013 21:21:02 +0200
Subject: [docs] IDLE error
Message-ID: <DUB120-W218A59670D37C899C8D2DDAE270@phx.gbl>

Hello! I recently installed Python 2.7.5 on my Windows 7 (64 bits), and I've been having problems with the IDLE, which keeps giving me an error message every time I try to run it. Here's what it says: "IDLE's subprocess didn't make connection. Either IDLE can't start a subprocess or personal firewall software is blocking the connection.". I uninstalled and reinstalled Python, I tried both versions offered on your website for Windows, none worked. What's the problem and how can I solve it? Thanks a lot in advance! 		 	   		  
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130917/65537502/attachment.html>

From panigrahirajeshkumar at gmail.com  Wed Sep 18 08:46:04 2013
From: panigrahirajeshkumar at gmail.com (Rajesh Panigrahi)
Date: Wed, 18 Sep 2013 12:16:04 +0530
Subject: [docs] bug in documentation
Message-ID: <CAEgVYQT+bWM-vuTf53ye5prYHDx5+sw+aU1epDQfmxP_6oJUMQ@mail.gmail.com>

Hello Team,
 There need a small correction in documentation page for

"14. Floating Point Arithmetic: Issues and Limitations"


Issue Description:- It has been written 0/2 + 0/4 + 1/8 = 0.001.

Expected :- The mathematical calculation should be written as 0.125.

Due to some problem i am not able to attach the screen shot.

Regards,
Rajesh

From report at bugs.python.org  Wed Sep 18 12:28:22 2013
From: report at bugs.python.org (Dmi Baranov)
Date: Wed, 18 Sep 2013 10:28:22 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379500102.52.0.954576711968.issue19038@psf.upfronthosting.co.za>


Dmi Baranov added the comment:

Guys, don't talk with bot - here is a summary [1] and his "history of glory" with patches to contributors lists [2]. Better way is cut-off this email from python.org services.

[1] http://wiki.gbatemp.net/wiki/User:TaeWong
[2] https://www.google.com/search?q=seotaewong40 at gmail.com

----------
nosy: +dmi.baranov
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 16:50:03 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Wed, 18 Sep 2013 14:50:03 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379515803.11.0.700920505418.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

The first link is a GBAtemp page.
The second link is a search.
You want to apply this patch.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 17:06:41 2013
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Sep 2013 15:06:41 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379516801.12.0.778774919209.issue19038@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Let's try a plain rejection first.

----------
resolution:  -> rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 17:11:36 2013
From: report at bugs.python.org (Tae-Wong SEO)
Date: Wed, 18 Sep 2013 15:11:36 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379517096.66.0.626571074266.issue19038@psf.upfronthosting.co.za>


Tae-Wong SEO added the comment:

Let's restore status and resolution without rejecting.

You want to apply this.

----------
resolution: rejected -> 
status: closed -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 17:53:13 2013
From: report at bugs.python.org (Benjamin Peterson)
Date: Wed, 18 Sep 2013 15:53:13 +0000
Subject: [docs] [issue19038] Fix sort order in Misc/ACKS.
In-Reply-To: <1379365334.74.0.639757614971.issue19038@psf.upfronthosting.co.za>
Message-ID: <1379519593.45.0.124869867291.issue19038@psf.upfronthosting.co.za>


Changes by Benjamin Peterson <benjamin at python.org>:


----------
resolution:  -> rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19038>
_______________________________________

From report at bugs.python.org  Wed Sep 18 19:15:43 2013
From: report at bugs.python.org (Claudiu.Popa)
Date: Wed, 18 Sep 2013 17:15:43 +0000
Subject: [docs] [issue18918] help('FILES') finds no documentation
In-Reply-To: <1378269620.52.0.763555902483.issue18918@psf.upfronthosting.co.za>
Message-ID: <1379524543.38.0.789973072249.issue18918@psf.upfronthosting.co.za>


Claudiu.Popa added the comment:

Hello. The 'File objects' section was removed in Python 3, with this issue http://bugs.python.org/issue7508, but not the topic from pydoc.py. As I understand, there is no point in having this, because there isn't a `file` type anymore.
The attached patched removes the `FILES` topic, which used an undefined reference ('bltin-file-objects', removed in the mentioned issue).

----------
keywords: +patch
nosy: +Claudiu.Popa
Added file: http://bugs.python.org/file31809/pydoc_files.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18918>
_______________________________________

From report at bugs.python.org  Wed Sep 18 22:17:50 2013
From: report at bugs.python.org (Berker Peksag)
Date: Wed, 18 Sep 2013 20:17:50 +0000
Subject: [docs] [issue18790] incorrect text in argparse add_help example
In-Reply-To: <1377025104.92.0.641943823333.issue18790@psf.upfronthosting.co.za>
Message-ID: <1379535470.49.0.298733438438.issue18790@psf.upfronthosting.co.za>


Berker Peksag added the comment:

This was reported a couple of times before on the docs list.

- https://mail.python.org/pipermail/docs/2013-April/015145.html
- https://mail.python.org/pipermail/docs/2013-June/015016.html
- https://mail.python.org/pipermail/docs/2013-September/015505.html

----------
nosy: +berker.peksag, ezio.melotti
stage:  -> patch review
versions: +Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18790>
_______________________________________

From report at bugs.python.org  Thu Sep 19 02:59:57 2013
From: report at bugs.python.org (Georg Brandl)
Date: Thu, 19 Sep 2013 00:59:57 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
Message-ID: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>


New submission from Georg Brandl:

As discussed on python-dev.

----------
assignee: docs at python
components: Documentation
files: license_fixup_33.patch
keywords: patch
messages: 198036
nosy: docs at python, georg.brandl
priority: normal
severity: normal
status: open
title: Remove detailed listing of all versions from LICENSE, Doc/license.rst
versions: Python 2.7, Python 3.3, Python 3.4
Added file: http://bugs.python.org/file31810/license_fixup_33.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Thu Sep 19 03:00:13 2013
From: report at bugs.python.org (Georg Brandl)
Date: Thu, 19 Sep 2013 01:00:13 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <1379552413.19.0.415359424834.issue19043@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


Added file: http://bugs.python.org/file31811/license_fixup_27.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Thu Sep 19 03:24:14 2013
From: report at bugs.python.org (Barry A. Warsaw)
Date: Thu, 19 Sep 2013 01:24:14 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <1379553854.48.0.163491878698.issue19043@psf.upfronthosting.co.za>


Changes by Barry A. Warsaw <barry at python.org>:


----------
nosy: +barry

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Thu Sep 19 03:49:15 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Thu, 19 Sep 2013 01:49:15 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <1379555355.93.0.324233670272.issue19043@psf.upfronthosting.co.za>


Changes by Ezio Melotti <ezio.melotti at gmail.com>:


----------
nosy: +ezio.melotti
stage:  -> patch review
type:  -> enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Thu Sep 19 08:10:51 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Thu, 19 Sep 2013 06:10:51 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379571050.96.0.7043715593.issue18553@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Georg: Thanks for spotting. I feel bad for the mistake. I shall correct it.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Thu Sep 19 09:10:24 2013
From: report at bugs.python.org (Roundup Robot)
Date: Thu, 19 Sep 2013 07:10:24 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <3cgTjC6cFBz7Ljs@mail.python.org>


Roundup Robot added the comment:

New changeset 2b7f11ba871c by Senthil Kumaran in branch '3.3':
Correcting the mistake in 14ba90816930
http://hg.python.org/cpython/rev/2b7f11ba871c

New changeset e839e524a7d5 by Senthil Kumaran in branch 'default':
Correcting the mistake in 678e3c0d2d99
http://hg.python.org/cpython/rev/e839e524a7d5

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Thu Sep 19 09:12:55 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Thu, 19 Sep 2013 07:12:55 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379574775.89.0.454050350546.issue18553@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Fixed now. Ascertained myself by doing hg diff -r tip^ -U 10 on local commits before pushing. :-)

----------
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Thu Sep 19 10:03:54 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Thu, 19 Sep 2013 08:03:54 +0000
Subject: [docs] [issue19047] Clarify weakref.finalize objects are kept
	alive	automatically
Message-ID: <1379577834.67.0.113922099701.issue19047@psf.upfronthosting.co.za>


New submission from Nick Coghlan:

I was just looking at weakref.finalize objects trying to figure out if they solve a problem I'm thinking about (they do), and I couldn't figure out from the class documentation ([1]) whether or not I needed to take care of keeping the object returned from weakref.finalize alive.

I don't (the module keeps finalizers alive automatically), but this critical piece of information is only mentioned in the example much further down in the documentation ([2]).

[1] http://docs.python.org/dev/library/weakref#weakref.finalize
[2] http://docs.python.org/dev/library/weakref#finalizer-objects

The 3.4 What's New should also explicitly mention weakref.finalize as an alternative to __del__ methods (perhaps as a comment in the section on PEP 422, perhaps just in the weakref section)

----------
assignee: docs at python
components: Documentation
messages: 198046
nosy: docs at python, ncoghlan
priority: normal
severity: normal
stage: needs patch
status: open
title: Clarify weakref.finalize objects are kept alive automatically
type: enhancement
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Thu Sep 19 10:25:12 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Thu, 19 Sep 2013 08:25:12 +0000
Subject: [docs] [issue19047] Assorted weakref docs improvements
In-Reply-To: <1379577834.67.0.113922099701.issue19047@psf.upfronthosting.co.za>
Message-ID: <1379579112.33.0.393587432785.issue19047@psf.upfronthosting.co.za>


Nick Coghlan added the comment:

Changing the title, since I spotted a few other problems as well.

The weakref docs still refer to module globals being set to None during shutdown. That is no longer the case. There are also some assumptions about cycles with __del__ methods not being garbage collected, which is no longer true given PEP 442's improvements to module finalization.

I also realised that the introduction of weakref.finalize and the elimination of the "set globals to None" hack gives Python relatively straightforward module destructors [1]:

    import weakref, sys
    mod = sys.modules[__name__]
    def del_this():
        # implicit ref to the module globals from the function body
    weakref.finalize(mod, del_this)

[1] https://mail.python.org/pipermail/import-sig/2013-September/000748.html

----------
title: Clarify weakref.finalize objects are kept alive automatically -> Assorted weakref docs improvements

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Thu Sep 19 13:31:36 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 19 Sep 2013 11:31:36 +0000
Subject: [docs] [issue19047] Assorted weakref docs improvements
In-Reply-To: <1379577834.67.0.113922099701.issue19047@psf.upfronthosting.co.za>
Message-ID: <1379590296.78.0.420360275719.issue19047@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

Doc patches certainly welcome :-)

----------
nosy: +pitrou, sbt

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Thu Sep 19 13:32:29 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 19 Sep 2013 11:32:29 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <1379590349.78.0.802773724129.issue19043@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

Looks good to me. Python 1.5.2 (which I've never used) is the best Python anyway!

----------
nosy: +pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Thu Sep 19 15:09:06 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Thu, 19 Sep 2013 13:09:06 +0000
Subject: [docs] [issue19047] Assorted weakref docs improvements
In-Reply-To: <1379590296.78.0.420360275719.issue19047@psf.upfronthosting.co.za>
Message-ID: <CADiSq7fniWnDvesBF8j6-G+uxGR3ZRhwzxt2mvCm5-susL6L8Q@mail.gmail.com>


Nick Coghlan added the comment:

I was initially thinking to myself "I have a source checkout right
here, I should just fix it, even though I'm at work and want to go
home"... and then I realised the potential scope of the fixes needed,
given the longstanding misbehaviours these docs assume still exist :)

(I also just realised the clone on my work system is ridiculously
stale, so even updating it will likely take a while at this point)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Thu Sep 19 16:47:28 2013
From: report at bugs.python.org (Dmi Baranov)
Date: Thu, 19 Sep 2013 14:47:28 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379602048.23.0.214793011945.issue18553@psf.upfronthosting.co.za>


Dmi Baranov added the comment:

I found a little difference in isatty implementaions:

Windows
Determines whether a file descriptor is associated with a character device [1]

Unix
Test whether a file descriptor refers to a terminal [2]

So, we having a same behavior for pipes, but different for I/O redirection with pseudo-character devices:

$ ./python -c "import os;print(os.isatty(0))" < /dev/null
False

e:\PCbuild>python_d.exe -c "import os;print(os.isatty(0))" < NUL
True

Other pseudo devices works simular:
e:\PCbuild>python_d.exe -c "import os;print(os.isatty(0))" < CON
True

I having a snippet to fix that, should I open a new issue for patch?


[1] http://msdn.microsoft.com/en-us/library/f4s0ddew.aspx
[2] http://man7.org/linux/man-pages/man3/isatty.3.html

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Thu Sep 19 17:16:44 2013
From: report at bugs.python.org (Senthil Kumaran)
Date: Thu, 19 Sep 2013 15:16:44 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1374752779.81.0.230915084667.issue18553@psf.upfronthosting.co.za>
Message-ID: <1379603804.26.0.457312085185.issue18553@psf.upfronthosting.co.za>


Senthil Kumaran added the comment:

Hello Dmi,

> I having a snippet to fix that, should I open a new issue for patch?

Please open a new issue.

Thanks!

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Thu Sep 19 19:26:26 2013
From: report at bugs.python.org (Marco Buttu)
Date: Thu, 19 Sep 2013 17:26:26 +0000
Subject: [docs] [issue19054] Descriptors howto
Message-ID: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>


New submission from Marco Buttu:

I think in the descriptor howto, at this point:

>>> class MyClass(object):
    x = RevealAccess(10, 'var "x"')
    y = 5

or the prompt should not have been, or there is a wrong indentation.
Furthermore, in Python 3:

http://docs.python.org/3/howto/descriptor.html

we can remove the explicit derivation from `object`

----------
assignee: docs at python
components: Documentation
messages: 198096
nosy: docs at python, marco.buttu
priority: normal
severity: normal
status: open
title: Descriptors howto
type: enhancement
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Thu Sep 19 19:42:55 2013
From: report at bugs.python.org (Marco Buttu)
Date: Thu, 19 Sep 2013 17:42:55 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379612575.56.0.1696875165.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


----------
keywords: +patch
Added file: http://bugs.python.org/file31820/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Thu Sep 19 19:43:14 2013
From: report at bugs.python.org (Marco Buttu)
Date: Thu, 19 Sep 2013 17:43:14 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379612594.6.0.144211433521.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Added file: http://bugs.python.org/file31821/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Fri Sep 20 02:51:04 2013
From: report at bugs.python.org (Ned Deily)
Date: Fri, 20 Sep 2013 00:51:04 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379638264.77.0.889557335095.issue19054@psf.upfronthosting.co.za>


Changes by Ned Deily <nad at acm.org>:


----------
nosy: +rhettinger
versions:  -Python 2.6, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From bgailer at gmail.com  Fri Sep 20 16:36:46 2013
From: bgailer at gmail.com (bob gailer)
Date: Fri, 20 Sep 2013 10:36:46 -0400
Subject: [docs] IDLE error
In-Reply-To: <DUB120-W218A59670D37C899C8D2DDAE270@phx.gbl>
References: <DUB120-W218A59670D37C899C8D2DDAE270@phx.gbl>
Message-ID: <523C5D7E.7020305@gmail.com>

docs is not the correct place for this question. I am forwarding it to 
<help at python.org.

On 9/17/2013 3:21 PM, Sergi Puig Villaplana wrote:

Hello! I recently installed Python 2.7.5 on my Windows 7 (64 bits), and 
I've been having problems with the IDLE, which keeps giving me an error 
message every time I try to run it. Here's what it says: "IDLE's 
subprocess didn't make connection. Either IDLE can't start a subprocess 
or personal firewall software is blocking the connection.". I 
uninstalled and reinstalled Python, I tried both versions offered on 
your website for Windows, none worked. What's the problem and how can I 
solve it? Thanks a lot in advance!

-- 
Bob Gailer
919-636-4239
Chapel Hill NC

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130920/39071b9c/attachment.html>

From report at bugs.python.org  Fri Sep 20 17:28:08 2013
From: report at bugs.python.org (Josh Lee)
Date: Fri, 20 Sep 2013 15:28:08 +0000
Subject: [docs] [issue10976] json.loads() raises TypeError on bytes object
In-Reply-To: <1295636509.41.0.0138366952356.issue10976@psf.upfronthosting.co.za>
Message-ID: <1379690888.94.0.189163279914.issue10976@psf.upfronthosting.co.za>


Changes by Josh Lee <jleedev at gmail.com>:


----------
nosy: +jleedev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10976>
_______________________________________

From report at bugs.python.org  Sat Sep 21 04:17:58 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 02:17:58 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379729878.8.0.100270044353.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31820/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 04:18:05 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 02:18:05 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379729885.43.0.0207480389423.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31821/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 04:24:31 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 02:24:31 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379730271.42.0.645343853618.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

Maybe is better to underline the difference between classes and non-classes objects, instead of between objects and classes, because a class is an object, so it could be confusing). 
Raymond, what do you think about rewriting this sentence:

  `The details of invocation depend on whether obj is an object or a class.`

as:

  `The details of invocation depend on whether obj is a class or not.`

I upload two new patches (one for py2 and the other for py3)

----------
Added file: http://bugs.python.org/file31828/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 04:24:49 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 02:24:49 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379730289.84.0.48920079671.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Added file: http://bugs.python.org/file31829/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 05:04:45 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 03:04:45 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379732685.58.0.15680806204.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31829/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 05:04:59 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 03:04:59 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379732699.5.0.409879546557.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Added file: http://bugs.python.org/file31830/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 05:19:15 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 03:19:15 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379733555.39.0.458505429008.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31828/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 05:22:29 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 03:22:29 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379733749.13.0.462497142412.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

I saw right now your decision about keeping object in the Python 3 doc:

http://bugs.python.org/issue17351#msg183870

So, now the py3 patch takes in account just the indentation of the `RevealAccess` example and the "class or not" suggestion.

----------
Added file: http://bugs.python.org/file31831/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 08:32:38 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sat, 21 Sep 2013 06:32:38 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379745158.28.0.30402047639.issue19054@psf.upfronthosting.co.za>


Changes by Raymond Hettinger <raymond.hettinger at gmail.com>:


----------
assignee: docs at python -> rhettinger
priority: normal -> low

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 08:45:46 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sat, 21 Sep 2013 06:45:46 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379745946.1.0.514538629401.issue19054@psf.upfronthosting.co.za>


Raymond Hettinger added the comment:

The indentation is not incorrect.  What you're seeing is normal for the interactive prompt.

Also, it is not incorrect to inherit from object in Python 3.
There is some value in keeping the document the same between versions.

----------
resolution:  -> invalid
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 09:29:55 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sat, 21 Sep 2013 07:29:55 +0000
Subject: [docs] [issue19060] docs: note that subprocess doesn't replace
	os.exec*
Message-ID: <1379748595.57.0.00736365306091.issue19060@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

I always thought that subprocess is replacing all other methods of executing external programs from Python and it is a preferred way. Perhaps I was not attentive that people isolate:
  os.system
  os.spawn*
  os.popen*
and
  os.exec*

While subprocess replaces three first, it doesn't do this with the last one. The documentation should mention this in the header block. Proposed edit:

  ...
  replace several other, older modules and functions, such as:

     os.system
     os.spawn*
     os.popen*
     popen2.*
     commands.*

+ Note that it doesn't replace other ways of executing external
+ processes from Python, such as:
+
+    os.exec*

  Information about how the subprocess module can be used
  ...

----------
assignee: docs at python
components: Documentation
messages: 198188
nosy: docs at python, techtonik
priority: normal
severity: normal
status: open
title: docs: note that subprocess doesn't replace os.exec*
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19060>
_______________________________________

From report at bugs.python.org  Sat Sep 21 09:30:46 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sat, 21 Sep 2013 07:30:46 +0000
Subject: [docs] [issue19060] docs: note that subprocess doesn't replace
	os.exec*
In-Reply-To: <1379748595.57.0.00736365306091.issue19060@psf.upfronthosting.co.za>
Message-ID: <1379748646.74.0.344971923938.issue19060@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

tag:easy (meaning, please mark it as easy for OpenHatch robots)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19060>
_______________________________________

From report at bugs.python.org  Sat Sep 21 12:44:26 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 10:44:26 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379760266.6.0.984248303253.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

I think the indentation is a problem, for several reasons. In all the examples in the documentation, the form by using the interactive shell is the following:

    >>> class MyClass:
    ...     pass

otherwise:

    class MyClass:
        pass

This one is awful:

>>> class MyClass:
    pass

and in fact it is no used in the doc. So if you want to put the class clause in the interactive shell, you have to add the dots to indent the suite of the compound statement, in order to be consistent with the rest of all the documentation.
But it is not just a problem of beauty:

$ python -m doctest descriptor.rst 
**********************************************************************
File "descriptor.rst", line 165, in descriptor.rst
Failed example:
    class MyClass(object):
Exception raised:
    ...
        class MyClass(object):
                             ^
    SyntaxError: unexpected EOF while parsing
...

By applying the patch, the definitions of the classes RevealAccess and MyClass pass the documentation test. The whole example does not pass in any case, because you are not consistent using the shell notation.

----------
Added file: http://bugs.python.org/file31833/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 12:44:46 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 10:44:46 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379760286.64.0.513614966247.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31830/py2howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 12:44:53 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 10:44:53 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379760293.6.0.0399781964154.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31831/py3howto.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 12:47:31 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 10:47:31 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379760451.99.0.641644223912.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


----------
resolution: invalid -> works for me
status: closed -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 14:44:28 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sat, 21 Sep 2013 12:44:28 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
Message-ID: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

This is a follow up to issue #8855. Currently the security warning is completely invisible from Python 2 docs http://docs.python.org/2/library/shelve.html and is located under screen border on Python 3 docs.

The proposal is to move warning out of the description of open() function to paragraph following module description, the same way is it is done for pickle http://docs.python.org/3.3/library/pickle.html

----------
assignee: docs at python
components: Documentation
messages: 198194
nosy: docs at python, techtonik
priority: normal
severity: normal
status: open
title: Shelve documentation security warning is not visible
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sat Sep 21 14:44:55 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sat, 21 Sep 2013 12:44:55 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379767495.46.0.253934850994.issue19061@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

tag:easy

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sat Sep 21 15:03:31 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 13:03:31 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379768611.51.0.733933061759.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

By looking at the other examples in the howto, I saw there is the same problem in all the definitions in the prompt, and furthermore, we are using a different number of spaces to indent MyClass respect the rest of the classes defined in the prompt. 
There is also a wrong indentation in the StaticMethod definition (no prompt definition):

class StaticMethod(object):
 "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

 def __init__(self, f):
      self.f = f

 def __get__(self, obj, objtype=None):
      return self.f

Applying the py3full.patch, the howto passes all the documentation tests:

$ python -m doctest descriptor.rst | tail -n 1
***Test Failed*** 18 failures.
$ python -m doctest descriptor_modified.rst | tail -n 1
$


My 2 cents

----------
Added file: http://bugs.python.org/file31834/py3full.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 15:38:39 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sat, 21 Sep 2013 13:38:39 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379770719.03.0.0956394080781.issue19054@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

In the latest patch there are 5-spaces indents in several places.

----------
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 16:28:42 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 14:28:42 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379773722.41.0.405535377949.issue19054@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


Removed file: http://bugs.python.org/file31834/py3full.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 16:29:10 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 14:29:10 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379773750.24.0.182121104004.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

You are right. Now it should be ok

----------
Added file: http://bugs.python.org/file31835/py3full.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 16:39:14 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 14:39:14 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379774354.16.0.48841804711.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

By the way, it does not pass all the tests in Python 2.7:

$ python2.7 -m doctest descriptor_modified.rst | tail -n 1
***Test Failed*** 3 failures.

If we want to be very rigorous, in order to pass the tests in Py2.7 too (kipping the rst aligned between py2 and py3), we have to add 3 others doctest: +SKIP directives. 

PS. I think there is a small bug in sphinx, related to our examples:

https://bitbucket.org/birkenfeld/sphinx/issue/1271/doctest-directive-and-dots-not-hidden

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 19:36:50 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sat, 21 Sep 2013 17:36:50 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379785010.09.0.386449360194.issue19054@psf.upfronthosting.co.za>


Changes by Raymond Hettinger <raymond.hettinger at gmail.com>:


----------
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sat Sep 21 21:58:31 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sat, 21 Sep 2013 19:58:31 +0000
Subject: [docs] [issue19054] Descriptors howto
In-Reply-To: <1379611586.05.0.268234554629.issue19054@psf.upfronthosting.co.za>
Message-ID: <1379793511.54.0.920015786281.issue19054@psf.upfronthosting.co.za>


Marco Buttu added the comment:

$ python -c "import this" | grep "silently"
Errors should never pass silently

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19054>
_______________________________________

From report at bugs.python.org  Sun Sep 22 02:33:39 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 22 Sep 2013 00:33:39 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379810019.45.0.441975007429.issue19024@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

Index entries for * and ** were added in #12531 so that both are indexed as operators, in function definitions, in function calls, and in the tutorial. If any of these places need improvement, there should be specific suggestions.

I do not think there should be separate documentation for the * symbol. It would only duplicate what is already present. There are many symbols with multiple uses.

Changing html search search for symbols, if possible, would be a different issue. But returning every use of '*' in the docs would not seem too useful. For anything in the index, the index in more useful.

----------
nosy: +terry.reedy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 03:18:36 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sun, 22 Sep 2013 01:18:36 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379812716.73.0.552166881332.issue19024@psf.upfronthosting.co.za>


Raymond Hettinger added the comment:

I concur with Terry.

----------
nosy: +rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 09:01:15 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sun, 22 Sep 2013 07:01:15 +0000
Subject: [docs] [issue19067] Built-in range docstrings are not PEP-8
	compatible
Message-ID: <1379833275.25.0.770459256521.issue19067@psf.upfronthosting.co.za>


New submission from Marco Buttu:

The range documentation is not PEP-8 compatible:

>>> range.__doc__.splitlines()[-1]
'Returns a virtual sequence of numbers from start to stop by step.'
>>> range.__reversed__.__doc__
'Returns a reverse iterator.'
>>> range.index.__doc__.splitlines()[-1]
'Raises ValueError if the value is not present.'

They should have been 'Return...' and 'Raise...'. Patch is attached

----------
assignee: docs at python
components: Documentation
files: rangeobject.patch
keywords: patch
messages: 198244
nosy: docs at python, marco.buttu
priority: normal
severity: normal
status: open
title: Built-in range docstrings are not PEP-8 compatible
type: enhancement
versions: Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file31838/rangeobject.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19067>
_______________________________________

From report at bugs.python.org  Sun Sep 22 09:09:02 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sun, 22 Sep 2013 07:09:02 +0000
Subject: [docs] [issue19068] Some built-in complex docstrings are not PEP-8
	compatible
Message-ID: <1379833742.32.0.289149108308.issue19068@psf.upfronthosting.co.za>


New submission from Marco Buttu:

As reported in the title: 

>>> complex.conjugate.__doc__.splitlines()[-1]
'Returns the complex conjugate of its argument. (3-4j).conjugate() == 3+4j.'
>>> complex.__format__.__doc__.splitlines()[-1]
'Converts to a string according to format_spec.'

They should have been 'Return...' and 'Convert...'. Patch is attached

----------
assignee: docs at python
components: Documentation
files: complexobject.patch
keywords: patch
messages: 198245
nosy: docs at python, marco.buttu
priority: normal
severity: normal
status: open
title: Some built-in complex docstrings are not PEP-8 compatible
versions: Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file31839/complexobject.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19068>
_______________________________________

From report at bugs.python.org  Sun Sep 22 09:09:57 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sun, 22 Sep 2013 07:09:57 +0000
Subject: [docs] [issue19068] Some built-in complex docstrings are not PEP-8
	compatible
In-Reply-To: <1379833742.32.0.289149108308.issue19068@psf.upfronthosting.co.za>
Message-ID: <1379833797.23.0.518427092014.issue19068@psf.upfronthosting.co.za>


Changes by Marco Buttu <marco.buttu at gmail.com>:


----------
type:  -> enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19068>
_______________________________________

From report at bugs.python.org  Sun Sep 22 09:18:11 2013
From: report at bugs.python.org (Marco Buttu)
Date: Sun, 22 Sep 2013 07:18:11 +0000
Subject: [docs] [issue19069] Built-in float docstrings are not PEP-8
	compatible
Message-ID: <1379834291.01.0.660875879281.issue19069@psf.upfronthosting.co.za>


New submission from Marco Buttu:

As reported in the title: 

>>> float.as_integer_ratio.__doc__.splitlines()[2]
'Returns a pair of integers, whose ratio is exactly equal to the original'
>>> float.as_integer_ratio.__doc__.splitlines()[4]
'Raises OverflowError on infinities and a ValueError on NaNs.'
>>> float.conjugate.__doc__
'Returns self, the complex conjugate of any float.'
>>> float.is_integer.__doc__
'Returns True if the float is an integer.'
>>> float.__setformat__.__doc__.splitlines()[-2]
'Overrides the automatic determination of C-level floating point type.'
...

They should have been 'Return...', 'Raise...' and 'Override...'
Patch is attached

----------
assignee: docs at python
components: Documentation
files: floatobject.patch
keywords: patch
messages: 198246
nosy: docs at python, marco.buttu
priority: normal
severity: normal
status: open
title: Built-in float docstrings are not PEP-8 compatible
type: enhancement
versions: Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file31840/floatobject.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19069>
_______________________________________

From report at bugs.python.org  Sun Sep 22 10:45:26 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Sep 2013 08:45:26 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379839526.06.0.863421129198.issue19061@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Using the "warning" directive can be backported from the 3.x docs.

For 3.x, it's already prominent enough. Your "screen border" is not everyone's screen border.

----------
nosy: +georg.brandl
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 11:21:51 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 09:21:51 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379841711.46.0.371986285189.issue19061@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

The scope of warning is wrong. It is not a warning for open() call, and that's why it is easy to miss.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 11:42:36 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Sep 2013 09:42:36 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379842956.62.0.187448398716.issue19061@psf.upfronthosting.co.za>


Georg Brandl added the comment:

Oh, please. It's big and red and directly below the open() description, how could you miss it?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 11:42:43 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 22 Sep 2013 09:42:43 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <3cjNxZ2Q17z7Ljj@mail.python.org>


Roundup Robot added the comment:

New changeset 1d850260a356 by Georg Brandl in branch '2.7':
Closes #19061: make shelve security warning consistent between 2.x and 3.x.
http://hg.python.org/cpython/rev/1d850260a356

----------
nosy: +python-dev
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 11:44:34 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 22 Sep 2013 09:44:34 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <3cjNzk1ywBz7Ljj@mail.python.org>


Roundup Robot added the comment:

New changeset 7a8616f21f26 by Georg Brandl in branch '2.7':
Closes #19043: remove detailed listing of versions from license files
http://hg.python.org/cpython/rev/7a8616f21f26

----------
nosy: +python-dev
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Sun Sep 22 11:46:23 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 22 Sep 2013 09:46:23 +0000
Subject: [docs] [issue19043] Remove detailed listing of all versions from
	LICENSE, Doc/license.rst
In-Reply-To: <1379552397.42.0.802042689988.issue19043@psf.upfronthosting.co.za>
Message-ID: <3cjP1p3PrCz7Ljj@mail.python.org>


Roundup Robot added the comment:

New changeset 59b6c3280827 by Georg Brandl in branch '3.3':
Closes #19043: remove detailed listing of versions from license files
http://hg.python.org/cpython/rev/59b6c3280827

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19043>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:08:12 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 11:08:12 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379842956.62.0.187448398716.issue19061@psf.upfronthosting.co.za>
Message-ID: <CAPkN8x+xw4TY0uru7v_DrYK1ZqhT31MbjGBtmYJW0nz8z6okug@mail.gmail.com>


anatoly techtonik added the comment:

On Sun, Sep 22, 2013 at 12:42 PM, Georg Brandl <report at bugs.python.org>wrote:

> Oh, please. It's big and red and directly below the open() description,
> how could you miss it?
>

I believe that it is pretty easy with mobile browser due to screen
constraints. Can you test this on your mobile devices?

As for your argument about my border not being everyone's border, I believe
that my border accounts for 18%+ of browser market share.
http://gs.statcounter.com/#mobile_vs_desktop-ww-monthly-201308-201308-bar I
would be even more interested to see docs.python.org stats, which may be
more, because reading docs from tablet is more convenient, or less, because
there tables are not good development platforms for Python.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:11:58 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Sep 2013 11:11:58 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379848317.96.0.746079129614.issue19061@psf.upfronthosting.co.za>


Georg Brandl added the comment:

> I believe that it is pretty easy with mobile browser due to screen
> constraints. Can you test this on your mobile devices?

Sorry, but we don't adapt the docs *content* to any specific device.  You should never only read just a screenful in any case.  This is technical documentation, not a news article!

If you believe that you can improve the docs *design* (the CSS, mainly) to work better on mobile devices, be my guest!  There are certainly optimization opportunities, but that never relieves you of making sure you read the whole content that's relevant to you.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:12:36 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 11:12:36 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379812716.73.0.552166881332.issue19024@psf.upfronthosting.co.za>
Message-ID: <CAPkN8xLHBfowKoc0kmt0zUGzACsZcs9J0OAkpbKnqsa9tiguqw@mail.gmail.com>


anatoly techtonik added the comment:

223 people + me out of 1422 disagree with you both.
http://stackoverflow.com/questions/101268/hidden-features-of-python

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:18:34 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 11:18:34 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <CAPkN8xLHBfowKoc0kmt0zUGzACsZcs9J0OAkpbKnqsa9tiguqw@mail.gmail.com>
Message-ID: <CAPkN8xL96WSd23aPHu1FU+C6i00dAuKt7WntxtFvDZSSfN8i7A@mail.gmail.com>


anatoly techtonik added the comment:

To narrow the point of conflict, I say that argument unpacking *operators*
should have a prominent place in Python documentation that people can link
to. Current page
http://docs.python.org/3/tutorial/controlflow.html#unpacking-argument-lists is
about functionality, not about operators, and therefore usage of these
while studying Python code can not be tracked back to documentation. Which
is why it is hidden.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:27:42 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 22 Sep 2013 11:27:42 +0000
Subject: [docs] [issue19047] Assorted weakref docs improvements
In-Reply-To: <1379577834.67.0.113922099701.issue19047@psf.upfronthosting.co.za>
Message-ID: <3cjRGk1Kq6z7LjR@mail.python.org>


Roundup Robot added the comment:

New changeset caa16423b324 by Nick Coghlan in branch 'default':
Close #19047: weakref doc cleanups
http://hg.python.org/cpython/rev/caa16423b324

----------
nosy: +python-dev
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:39:56 2013
From: report at bugs.python.org (Graham Dumpleton)
Date: Sun, 22 Sep 2013 11:39:56 +0000
Subject: [docs] [issue19071] Documentation on what self is for module-level
	functions	is misleading/wrong.
Message-ID: <1379849996.18.0.35390897499.issue19071@psf.upfronthosting.co.za>


New submission from Graham Dumpleton:

In the documentation for Python 2.X at:

http://docs.python.org/2/extending/extending.html#a-simple-example

it says:

"""
The self argument points to the module object for module-level functions; for a method it would point to the object instance.
"""

In respect of module-level functions this is misleading or arguably wrong.

If one uses Py_InitModule() or Py_InitModule3(), then self is actually passed through as NULL for module-level functions in Python 2.

There is a caveat on use of Py_InitModule4() which used to be mentioned in documentation for Python 2.6 at:

http://docs.python.org/release/2.6.7/c-api/structures.html#METH_VARARGS

where it says:

"""
This is the typical calling convention, where the methods have the type PyCFunction. The function expects two PyObject* values. The first one is the self object for methods; for module functions, it has the value given to Py_InitModule4() (or NULL if Py_InitModule() was used).
"""

Although one can supply a special argument to Py_InitModule4() which will be supplied as self, this still isn't the module object and in fact the module object for the module will not even exist at the point Py_InitModule4() is called so it is not possible to pass it in. Plus within the init function of an extension, the module object is not that which would end up being used in a specific interpreter due to how the init function is only called once and a copy then made of the module for each interpreter.

This actual page in the documentation was changed in Python 2.7 and now in:

http://docs.python.org/2/c-api/structures.html#METH_VARARGS

says:

"""
The function expects two PyObject* values. The first one is the self object for methods; for module functions, it is the module object.
"""

So the reference to Py_InitModule4() was removed and simply says that module object is supplied, which isn't actually the case.

Now, that NULL is always passed for Py_InitModule() and Py_InitModule3() is the case with Python 2. In Python 3 at some point, the code in Python internals was changed so the module object is actually passed as documented.

So, maybe the intent was that when in Python 3 the code was changed to pass the module object to module-level functions that it be back ported to Python 2.7 and the documentation so changed, but looks like that back porting was never done, or if it was, it has been broken somewhere along the way.

Code used to verify this is all attached.

If compiled and installed for Python 3 one gets:

>>> import mymodule._extension
>>> id(mymodule._extension)
4480540328
>>> mymodule._extension.function()
<module 'mymodule._extension' from '/Users/graham/Projects/python-c-extension-template/lib/python3.3/site-packages/mymodule/_extension.so'>
>>> id(mymodule._extension.function())
4480540328

If compiled and installed for Python 2.7 one gets:

>>> import mymodule._extension
>>> id(mymodule._extension)
4554745960
>>> mymodule._extension.function()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: no module supplied for self

The function in the extension module was doing:

static PyObject *extension_function(PyObject *self, PyObject *args)
{
    if (!self) {
        PyErr_SetString(PyExc_TypeError, "no module supplied for self");
        return NULL;
    }

    Py_INCREF(self);
    return self;
}

----------
assignee: docs at python
components: Documentation
files: example.tar
messages: 198265
nosy: docs at python, grahamd
priority: normal
severity: normal
status: open
title: Documentation on what self is for module-level functions is misleading/wrong.
type: behavior
versions: Python 2.7
Added file: http://bugs.python.org/file31841/example.tar

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19071>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:42:04 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 11:42:04 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379848317.96.0.746079129614.issue19061@psf.upfronthosting.co.za>
Message-ID: <CAPkN8xKDqPvaiwaq7Whm6ErkMBcbyu+MouyoA2UWoB=QhB=9Mw@mail.gmail.com>


anatoly techtonik added the comment:

On Sun, Sep 22, 2013 at 2:11 PM, Georg Brandl <report at bugs.python.org>wrote:

>
> Georg Brandl added the comment:
>
> > I believe that it is pretty easy with mobile browser due to screen
> > constraints. Can you test this on your mobile devices?
>
> Sorry, but we don't adapt the docs *content* to any specific device.  You
> should never only read just a screenful in any case.  This is technical
> documentation, not a news article!
>

I am sorry, but you're misplacing arguments. It looks like this:

me[1]> open() function description is a wrong place for warning that is
related to a whole module
you[2]> common, it is visible, that's the point anyway
me[3]> it is not visible on mobile
you[4]> we do not support mobile

[3] makes your point [2] invalid. And your point [4] doesn't apply as an
answer to [1].

 Now my arguments are:
1. Warning is located in the wrong place (bug is trivial, not important)
2. Wrong place causes problems with mobiles (trivial, somewhat matters)

And you argument that users (or is it for me personally?) should never read
only screenful for a module description is rather strange for the most of
us.

   "Why are things always in the last place you look for them?
    Because you stop looking when you find them."

I highly recommend you to read this book -
http://www.sensible.com/chapter.html - it's awesome.
And just for amusement -
http://uxmyths.com/post/647473628/myth-people-read-on-the-web

> If you believe that you can improve the docs *design* (the CSS, mainly) to
> work better on mobile devices, be my guest!  There are certainly
> optimization opportunities, but that never relieves you of making sure you
> read the whole content that's relevant to you.
>

There is nothing wrong with CSS or mobile design. There is an issue with
the placement of this specific piece of information, which comes detached
from the place (module description) where it belongs. Although the effect
of this bug is partially with background workaround, the cause is still
there.

To make it more real scenario for you. In corporate environment somebody
who issues a recommendation, is not necessarily the person who implements
it. If you're implementing everything yourself, of course you won't miss
the details.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:48:06 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Sun, 22 Sep 2013 11:48:06 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379850486.67.0.172276426578.issue19024@psf.upfronthosting.co.za>


Nick Coghlan added the comment:

Unfortunately, there's currently no good place for this kind of detailed syntax reference documentation to go. The library reference doesn't cover syntax, the tutorial doesn't go into detailed semantics, and the language reference is written more for language implementors than it is for users.

My Python User's Reference project (http://svn.python.org/view/sandbox/trunk/userref/README.txt?view=markup) was designed to fill that gap, but I never found the time to do the ReST conversion myself, and nobody ever expressed interest in helping out with it, so it's now five years out of date.

Creating a cut down version of that as the "Python Syntax Reference" might be a reasonable approach. However, it's a project that could easily start life outside the core CPython repository.

----------
nosy: +ncoghlan

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:51:58 2013
From: report at bugs.python.org (Nick Coghlan)
Date: Sun, 22 Sep 2013 11:51:58 +0000
Subject: [docs] [issue19071] Documentation on what self is for module-level
	functions	is misleading/wrong.
In-Reply-To: <1379849996.18.0.35390897499.issue19071@psf.upfronthosting.co.za>
Message-ID: <1379850718.0.0.811939185165.issue19071@psf.upfronthosting.co.za>


Changes by Nick Coghlan <ncoghlan at gmail.com>:


----------
nosy: +loewis, ncoghlan, pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19071>
_______________________________________

From report at bugs.python.org  Sun Sep 22 13:57:50 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Sep 2013 11:57:50 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379767468.36.0.787421761294.issue19061@psf.upfronthosting.co.za>
Message-ID: <1379851069.95.0.20520057885.issue19061@psf.upfronthosting.co.za>


Georg Brandl added the comment:

> me[1]> open() function description is a wrong place for warning that is
related to a whole module
> you[2]> common, it is visible, that's the point anyway
> me[3]> it is not visible on mobile
> you[4]> we do not support mobile

Your complaint was that it is "located under screen border".  My reply is that what the "screen border" is is highly device specific and that  we don't cater to specific devices, therefore rejecting your complaint.  I never said "we don't support mobile".  That's it for me and this issue.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 14:08:53 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 12:08:53 +0000
Subject: [docs] [issue19061] Shelve documentation security warning is not
	visible
In-Reply-To: <1379851069.95.0.20520057885.issue19061@psf.upfronthosting.co.za>
Message-ID: <CAPkN8x+rcB+qo5FjnQGQvYH22Tj5qUtaS7gPyyiF0yf5JiBGWg@mail.gmail.com>


anatoly techtonik added the comment:

On Sun, Sep 22, 2013 at 2:57 PM, Georg Brandl <report at bugs.python.org>wrote:

>
> Georg Brandl added the comment:
>
> > me[1]> open() function description is a wrong place for warning that is
> related to a whole module
> > you[2]> common, it is visible, that's the point anyway
> > me[3]> it is not visible on mobile
> > you[4]> we do not support mobile
>
> Your complaint was that it is "located under screen border".  My reply is
> that what the "screen border" is is highly device specific and that  we
> don't cater to specific devices, therefore rejecting your complaint.  I
> never said "we don't support mobile".  That's it for me and this issue.
>

Well, at least now you know how I read the replies. Glad we settled this
down. Now it would be nice if somebody with CLA for docs could just move
this block upper.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19061>
_______________________________________

From report at bugs.python.org  Sun Sep 22 14:12:44 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 12:12:44 +0000
Subject: [docs] [issue18553] os.isatty() is not Unix only
In-Reply-To: <1379603804.26.0.457312085185.issue18553@psf.upfronthosting.co.za>
Message-ID: <CAPkN8x+cuqmh6ds8e=qjm7qzVhfP4722K1aFOegrd=Ype52fzA@mail.gmail.com>


anatoly techtonik added the comment:

>
> > I having a snippet to fix that, should I open a new issue for patch?
>
> Please open a new issue.
>

Reference is welcome.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18553>
_______________________________________

From report at bugs.python.org  Sun Sep 22 16:16:17 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 14:16:17 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
Message-ID: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

http://docs.python.org/2/faq/gui.html - this page misses info about PySide.

----------
assignee: docs at python
components: Documentation
messages: 198279
nosy: docs at python, techtonik
priority: normal
severity: normal
status: open
title: Add PySide to GUI FAQ
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 16:42:31 2013
From: report at bugs.python.org (Brett Cannon)
Date: Sun, 22 Sep 2013 14:42:31 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379860951.31.0.480063353229.issue19074@psf.upfronthosting.co.za>


Brett Cannon added the comment:

I say we just delete that page. Trying to keep up with GUI toolkits is a losing battle (as shown by this bug report) and not worth our time and effort to try to maintain. Search engines are your friend in this instance.

----------
nosy: +brett.cannon

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 16:42:48 2013
From: report at bugs.python.org (Brett Cannon)
Date: Sun, 22 Sep 2013 14:42:48 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379860968.08.0.782804998384.issue19074@psf.upfronthosting.co.za>


Changes by Brett Cannon <brett at python.org>:


----------
priority: normal -> low
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 16:51:05 2013
From: report at bugs.python.org (Christian Heimes)
Date: Sun, 22 Sep 2013 14:51:05 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379861465.03.0.58125647714.issue19074@psf.upfronthosting.co.za>


Christian Heimes added the comment:

The wiki is probably a better place for such information.

----------
nosy: +christian.heimes
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 17:09:18 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 15:09:18 +0000
Subject: [docs] [issue15329] clarify which deque methods are thread-safe
In-Reply-To: <1342044644.52.0.376014623438.issue15329@psf.upfronthosting.co.za>
Message-ID: <1379862558.1.0.294825697685.issue15329@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

So, is deque a faster replacement for Queue.Queue or not?

----------
nosy: +techtonik

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15329>
_______________________________________

From report at bugs.python.org  Sun Sep 22 18:14:12 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 22 Sep 2013 16:14:12 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1379866452.57.0.339750639541.issue19024@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

The StackOverflow question and answer about function calls is 5 years old and therefore out of date with respect to #12531, which specifically added index entries for function calls.

Perhaps my Python 3 symbol glossary "Python3 Syntax Symbol Uses"

https://code.google.com/p/xploro/downloads/detail?name=PySymbols.html&can=1&q=

could be expanded a bit or combined with other text, as well as being a basis for adding index entries.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From report at bugs.python.org  Sun Sep 22 19:30:34 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 22 Sep 2013 17:30:34 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379871034.58.0.388915899025.issue19074@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

If only wiki had a theme like Sphinx docs.. But I agree that static FAQ look dead compared to wiki or stackoverflow.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 19:35:20 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Sun, 22 Sep 2013 17:35:20 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379871320.51.0.91825187514.issue19074@psf.upfronthosting.co.za>


Eli Bendersky added the comment:

+1 to delete

----------
nosy: +eli.bendersky

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Sun Sep 22 21:13:00 2013
From: report at bugs.python.org (Richard Oudkerk)
Date: Sun, 22 Sep 2013 19:13:00 +0000
Subject: [docs] [issue19047] Assorted weakref docs improvements
In-Reply-To: <1379577834.67.0.113922099701.issue19047@psf.upfronthosting.co.za>
Message-ID: <1379877180.81.0.720621920102.issue19047@psf.upfronthosting.co.za>


Richard Oudkerk added the comment:

Thanks for the doc cleanup -- I am rather busy right now.

Note that stuff does still get replaced by None at shutdown, and this can still produce errors, even if they are much harder to trigger.  If I run the following program

    import _weakref
    import collections

    a = "hello"

    class Foo(object):
        def __del__(self):
            print(a)

    collections.foo = Foo()
    _weakref.foo = Foo()

then depending on the initial hashseed I get a reproducible error:

    $ PYTHONHASHSEED=7 python-release /tmp/bad.py
    Exception ignored in: <bound method Foo.__del__ of <__main__.Foo object at 0xb733db8c>>
    Traceback (most recent call last):
      File "/tmp/bad.py", line 8, in __del__
    TypeError: 'NoneType' object is not callable

(Personally I would like to see a flag set late during shutdown which blocks __del__ methods from running.)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19047>
_______________________________________

From report at bugs.python.org  Sun Sep 22 23:18:23 2013
From: report at bugs.python.org (Brett Cannon)
Date: Sun, 22 Sep 2013 21:18:23 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379884703.1.0.540346046747.issue19074@psf.upfronthosting.co.za>


Changes by Brett Cannon <brett at python.org>:


----------
assignee: docs at python -> brett.cannon

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Mon Sep 23 00:08:51 2013
From: report at bugs.python.org (Ezio Melotti)
Date: Sun, 22 Sep 2013 22:08:51 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379887731.1.0.762458782034.issue19074@psf.upfronthosting.co.za>


Ezio Melotti added the comment:

Note that we have a somewhat similar HOWTO about using Python in the web: http://docs.python.org/dev/howto/webservers.html
The HOWTO mentions at the top that it can't keep track of all the several web framework and links to the wiki for a more updated page.
The same approach could be followed here too, if we want to keep that page.

----------
assignee: brett.cannon -> docs at python
nosy: +ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Mon Sep 23 00:12:56 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Sun, 22 Sep 2013 22:12:56 +0000
Subject: [docs] [issue19074] Add PySide to GUI FAQ
In-Reply-To: <1379859377.69.0.892253164041.issue19074@psf.upfronthosting.co.za>
Message-ID: <1379887976.05.0.318672792927.issue19074@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

Actually PySide is mentioned in the 3.x version of the docs.

----------
nosy: +pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19074>
_______________________________________

From report at bugs.python.org  Mon Sep 23 03:40:35 2013
From: report at bugs.python.org (Ethan Furman)
Date: Mon, 23 Sep 2013 01:40:35 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1379900435.27.0.0400873355063.issue19040@psf.upfronthosting.co.za>


Ethan Furman added the comment:

How about this note after the AutoNumber example?

.. note::

    The :meth:`__new__` method, if defined, is used during creation of the Enum
    members; it is then replaced by Enum's :meth:`__new__` which is used after
    class creation for lookup of existing members.  Due to the way Enums are
    supposed to behave, there is no way to customize Enum's :meth:`__new__`.

----------
nosy: +barry, eli.bendersky
stage:  -> patch review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Mon Sep 23 04:26:49 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Mon, 23 Sep 2013 02:26:49 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1379903209.43.0.995025952468.issue19040@psf.upfronthosting.co.za>


Eli Bendersky added the comment:

LGTM, Ethan. You know how I feel about customization in general ;-) We should give Enum a term or two in the stdlib to learn how it's being used and abused - we can always *add* customization in the future.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Mon Sep 23 06:04:07 2013
From: report at bugs.python.org (Ethan Furman)
Date: Mon, 23 Sep 2013 04:04:07 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1379909046.99.0.844905213611.issue19040@psf.upfronthosting.co.za>


Ethan Furman added the comment:

Yup, just trying to add some explanation on how it currently works.

Drekin, I'm sure you've already figured this out, but for those who may read this in the future:  what you need is a helper function:

def OptionalEnum(value):
    "could also be OptionalEnum(enum, value)"
    try:
        return SomeEnum(value) # or return enum(value)
    except ValueError:
        return value

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Mon Sep 23 10:04:07 2013
From: report at bugs.python.org (Drekin)
Date: Mon, 23 Sep 2013 08:04:07 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1379923447.24.0.5239522334.issue19040@psf.upfronthosting.co.za>


Drekin added the comment:

Yes, I've done it similarily using a class method. Thank you for help.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Mon Sep 23 12:28:02 2013
From: report at bugs.python.org (Mark Egan-Fuller)
Date: Mon, 23 Sep 2013 10:28:02 +0000
Subject: [docs] [issue17777] Unrecognized string literal escape sequences
	give	SyntaxErrors
In-Reply-To: <1366213055.37.0.161368185198.issue17777@psf.upfronthosting.co.za>
Message-ID: <1379932082.55.0.506081911596.issue17777@psf.upfronthosting.co.za>


Mark Egan-Fuller added the comment:

Python correctly throws a unicode error here, directing the user towards the fact that this is an issue specifically with the unicode escaping.

>>> "\u"
  File "<stdin>", line 1
SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 0-1: truncated \uXXXX escape


The documentation also states that "Any Unicode character can be encoded this way. Exactly eight hex digits are required."[0].

Propose closing this as Won't Fix.

[0]: http://docs.python.org/3/reference/lexical_analysis.html#literals

----------
nosy: +markeganfuller, tim.golden

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17777>
_______________________________________

From report at bugs.python.org  Mon Sep 23 15:57:27 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Mon, 23 Sep 2013 13:57:27 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379909046.99.0.844905213611.issue19040@psf.upfronthosting.co.za>
Message-ID: <CAF-Rda9m2B5rQsJVp=m2cdjqUY44POks3OAq2NTuB1X8=eXQAg@mail.gmail.com>


Eli Bendersky added the comment:

On Sun, Sep 22, 2013 at 9:04 PM, Ethan Furman <report at bugs.python.org>wrote:

>
> Ethan Furman added the comment:
>
> Yup, just trying to add some explanation on how it currently works.
>
> Drekin, I'm sure you've already figured this out, but for those who may
> read this in the future:  what you need is a helper function:
>
> def OptionalEnum(value):
>     "could also be OptionalEnum(enum, value)"
>     try:
>         return SomeEnum(value) # or return enum(value)
>     except ValueError:
>         return value
>

Hmm, looks suspiciously similar to _inienum_converter from socket.py ;-)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Tue Sep 24 04:55:35 2013
From: report at bugs.python.org (=?utf-8?q?Westley_Mart=C3=ADnez?=)
Date: Tue, 24 Sep 2013 02:55:35 +0000
Subject: [docs] [issue11176] give more meaningful argument names in
	argparse	documentation
In-Reply-To: <1297352937.46.0.470038569364.issue11176@psf.upfronthosting.co.za>
Message-ID: <1379991335.35.0.980357411345.issue11176@psf.upfronthosting.co.za>


Westley Mart?nez added the comment:

I've skimmed through the patches.  Good job kids.  This is much better than it was before.  No more of that silly command-line calculator or the foobar nonsense that sounds drier than the POSIX standard.

Is there anything else that needs to be done?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11176>
_______________________________________

From report at bugs.python.org  Tue Sep 24 12:01:14 2013
From: report at bugs.python.org (Tim Golden)
Date: Tue, 24 Sep 2013 10:01:14 +0000
Subject: [docs] [issue17777] Unrecognized string literal escape sequences
	give	SyntaxErrors
In-Reply-To: <1366213055.37.0.161368185198.issue17777@psf.upfronthosting.co.za>
Message-ID: <1380016874.7.0.58090376897.issue17777@psf.upfronthosting.co.za>


Tim Golden added the comment:

Closing as "Works for me" in the absence of any clear proposal for docs improvement.

----------
resolution:  -> works for me
stage: needs patch -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17777>
_______________________________________

From report at bugs.python.org  Wed Sep 25 01:53:38 2013
From: report at bugs.python.org (A. Jesse Jiryu Davis)
Date: Tue, 24 Sep 2013 23:53:38 +0000
Subject: [docs] [issue19071] Documentation on what self is for module-level
	functions	is misleading/wrong.
In-Reply-To: <1379849996.18.0.35390897499.issue19071@psf.upfronthosting.co.za>
Message-ID: <1380066818.74.0.944530997209.issue19071@psf.upfronthosting.co.za>


Changes by A. Jesse Jiryu Davis <jesse at emptysquare.net>:


----------
nosy: +emptysquare

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19071>
_______________________________________

From report at bugs.python.org  Wed Sep 25 05:09:39 2013
From: report at bugs.python.org (Ethan Furman)
Date: Wed, 25 Sep 2013 03:09:39 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1380078579.39.0.0427888382128.issue19040@psf.upfronthosting.co.za>


Ethan Furman added the comment:

Doc patch is in #19011.  I'll close this one when that one is closed.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Thu Sep 26 01:33:02 2013
From: report at bugs.python.org (Dariusz Suchojad)
Date: Wed, 25 Sep 2013 23:33:02 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
Message-ID: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>


New submission from Dariusz Suchojad:

Hello,

I'd like to suggest adding a simple note to SSLSocket.getpeercert stating that it will always return None if do_handshake has never been called.

This is not the default behaviour, by default SSLSocket.__init__'s do_handshake_on_connect is True so .getpeercert nicely returns a cert (assuming the usual caveats - the other side offers a certificate and cert_reqs is not CERT_NONE).

However, I've just been debugging a someone else's server and I spent some time figuring out why client certificates weren't available - turned out this was because do_handshake was never called (PySSL_SSLdo_handshake in _ssl.c).

Adding a single-sentence line will certainly be very helpful.

Many thanks!

----------
assignee: docs at python
components: Documentation
messages: 198425
nosy: docs at python, dsuch
priority: normal
severity: normal
status: open
title: Document SSLSocket.getpeercert always returns None without do_handshake
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Thu Sep 26 10:45:59 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 26 Sep 2013 08:45:59 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <1380185159.55.0.613207667716.issue19095@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

To be honest I'd rather have it raise an exception in that case. None isn't helpful as it could mean other things.

----------
nosy: +christian.heimes, giampaolo.rodola, janssen, pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Thu Sep 26 12:45:12 2013
From: report at bugs.python.org (Dariusz Suchojad)
Date: Thu, 26 Sep 2013 10:45:12 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <1380192312.26.0.370034789618.issue19095@psf.upfronthosting.co.za>


Dariusz Suchojad added the comment:

> None isn't helpful as it could mean other things.

This is another story but yes, it's true. API-wise, None should be returned in one situation only - we're on server side, ca_certs is non-CERT_NONE, do_handshake has been called yet there is no client certificate. And no other checks should be applied.

But the current behavior of returning None is documented and people depend on it so straightening it out would break backward compatibility - it's up to you to decide. I wouldn't mind it personally. 

But as far as this ticket goes - I'm on 2.7 and it's set in stone so for 2.7 - can you please change copy only? If you decide that for 3.x an exception will be raised then such a caveat would be included in 2.7 docs as well.

Thanks again.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Thu Sep 26 14:40:23 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 26 Sep 2013 12:40:23 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380192312.26.0.370034789618.issue19095@psf.upfronthosting.co.za>
Message-ID: <1946526867.24902757.1380199216762.JavaMail.root@zimbra10-e2.priv.proxad.net>


Antoine Pitrou added the comment:

> But the current behavior of returning None is documented and people
> depend on it so straightening it out would break backward
> compatibility - it's up to you to decide. I wouldn't mind it
> personally.

I'm not sure people depend on getpeercert() returning None before the
handshake is done, or perhaps by accident?

> But as far as this ticket goes - I'm on 2.7 and it's set in stone so
> for 2.7 - can you please change copy only? If you decide that for
> 3.x an exception will be raised then such a caveat would be included
> in 2.7 docs as well.

Yes, if we change behaviour it will only be in 3.4.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Thu Sep 26 15:20:50 2013
From: report at bugs.python.org (Dariusz Suchojad)
Date: Thu, 26 Sep 2013 13:20:50 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <1380201650.8.0.07900278874.issue19095@psf.upfronthosting.co.za>


Dariusz Suchojad added the comment:

> I'm not sure people depend on getpeercert() returning None before the
> handshake is done, or perhaps by accident?

Ah, no, I meant that people may depend on the documented behaviour of .getpeercert's returning an empty dict (which I mixed up with returning None) if the certificate was not validated.

That this dictionary's contents depends on the validation is a bit quirky but it's documented so changing that one would surely break existing code.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Thu Sep 26 20:38:55 2013
From: report at bugs.python.org (Eli Bendersky)
Date: Thu, 26 Sep 2013 18:38:55 +0000
Subject: [docs] [issue15964] SyntaxError in asdl when building 2.7 with
	system Python	3
In-Reply-To: <1347978379.29.0.810502621141.issue15964@psf.upfronthosting.co.za>
Message-ID: <1380220735.2.0.75906899023.issue15964@psf.upfronthosting.co.za>


Eli Bendersky added the comment:

Did anyone ended up updating the devguide about this? I can't find anything related in there.

----------
nosy: +eli.bendersky

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15964>
_______________________________________

From report at bugs.python.org  Sat Sep 28 05:46:35 2013
From: report at bugs.python.org (Tshepang Lekhonkhobe)
Date: Sat, 28 Sep 2013 03:46:35 +0000
Subject: [docs] [issue19067] Built-in range docstrings are not PEP-8
	compatible
In-Reply-To: <1379833275.25.0.770459256521.issue19067@psf.upfronthosting.co.za>
Message-ID: <1380339995.26.0.218263883808.issue19067@psf.upfronthosting.co.za>


Changes by Tshepang Lekhonkhobe <tshepang at gmail.com>:


----------
nosy: +tshepang

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19067>
_______________________________________

From report at bugs.python.org  Sat Sep 28 05:46:41 2013
From: report at bugs.python.org (Tshepang Lekhonkhobe)
Date: Sat, 28 Sep 2013 03:46:41 +0000
Subject: [docs] [issue19069] Built-in float docstrings are not PEP-8
	compatible
In-Reply-To: <1379834291.01.0.660875879281.issue19069@psf.upfronthosting.co.za>
Message-ID: <1380340001.8.0.659202910632.issue19069@psf.upfronthosting.co.za>


Changes by Tshepang Lekhonkhobe <tshepang at gmail.com>:


----------
nosy: +tshepang

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19069>
_______________________________________

From report at bugs.python.org  Sat Sep 28 05:47:15 2013
From: report at bugs.python.org (Tshepang Lekhonkhobe)
Date: Sat, 28 Sep 2013 03:47:15 +0000
Subject: [docs] [issue19068] Some built-in complex docstrings are not PEP-8
	compatible
In-Reply-To: <1379833742.32.0.289149108308.issue19068@psf.upfronthosting.co.za>
Message-ID: <1380340035.88.0.714448265776.issue19068@psf.upfronthosting.co.za>


Changes by Tshepang Lekhonkhobe <tshepang at gmail.com>:


----------
nosy: +tshepang

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19068>
_______________________________________

From report at bugs.python.org  Sat Sep 28 06:35:29 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sat, 28 Sep 2013 04:35:29 +0000
Subject: [docs] [issue19069] Built-in float docstrings are not PEP-8
	compatible
In-Reply-To: <1379834291.01.0.660875879281.issue19069@psf.upfronthosting.co.za>
Message-ID: <1380342929.25.0.970749672461.issue19069@psf.upfronthosting.co.za>


Raymond Hettinger added the comment:

Please don't flood the tracker with these individual reports.  Present a single consolidated patch in Issue 19069.

----------
nosy: +rhettinger
resolution:  -> duplicate
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19069>
_______________________________________

From report at bugs.python.org  Sat Sep 28 06:38:03 2013
From: report at bugs.python.org (Raymond Hettinger)
Date: Sat, 28 Sep 2013 04:38:03 +0000
Subject: [docs] [issue19067] Built-in range docstrings are not PEP-8
	compatible
In-Reply-To: <1379833275.25.0.770459256521.issue19067@psf.upfronthosting.co.za>
Message-ID: <1380343083.84.0.68303205511.issue19067@psf.upfronthosting.co.za>


Changes by Raymond Hettinger <raymond.hettinger at gmail.com>:


----------
priority: normal -> low

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19067>
_______________________________________

From report at bugs.python.org  Sat Sep 28 07:59:24 2013
From: report at bugs.python.org (Ethan Furman)
Date: Sat, 28 Sep 2013 05:59:24 +0000
Subject: [docs] [issue19040] Problems with overriding Enum.__new__
In-Reply-To: <1379412637.64.0.0140304446713.issue19040@psf.upfronthosting.co.za>
Message-ID: <1380347964.57.0.149220716531.issue19040@psf.upfronthosting.co.za>


Changes by Ethan Furman <ethan at stoneleaf.us>:


----------
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19040>
_______________________________________

From report at bugs.python.org  Sat Sep 28 10:37:16 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sat, 28 Sep 2013 08:37:16 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
Message-ID: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

See http://www.python.org/dev/peps/, click Last-Modified.

----------
assignee: docs at python
components: Documentation
messages: 198509
nosy: docs at python, techtonik
priority: normal
severity: normal
status: open
title: PEP-0 history link is broken

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sat Sep 28 21:10:41 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sat, 28 Sep 2013 19:10:41 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
In-Reply-To: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>
Message-ID: <3cnKG85xRHz7LjQ@mail.python.org>


Roundup Robot added the comment:

New changeset aba730d39749 by Ned Deily in branch 'default':
Issue #19110: Surpress Last-Modified link in PEP 0 html
http://hg.python.org/peps/rev/aba730d39749

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sat Sep 28 21:30:42 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 28 Sep 2013 19:30:42 +0000
Subject: [docs] [issue19060] docs: note that subprocess doesn't replace
	os.exec*
In-Reply-To: <1379748595.57.0.00736365306091.issue19060@psf.upfronthosting.co.za>
Message-ID: <1380396642.85.0.857227999019.issue19060@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

The problem with the current text is 'such as', implying that there are other unlisted items that could have (should have?) been added to make the list complete. If the list is complete, 'such as' could just be removed. If a sentence were added, I would simplify it to
"It does not replace os.exec*." or perhaps "os.fork and os.exec*.".

----------
keywords: +easy
nosy: +loewis, terry.reedy
versions:  -Python 2.6, Python 3.1, Python 3.2, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19060>
_______________________________________

From report at bugs.python.org  Sat Sep 28 22:17:15 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 28 Sep 2013 20:17:15 +0000
Subject: [docs] [issue19067] Built-in range docstrings are not PEP-8
	compatible
In-Reply-To: <1379833275.25.0.770459256521.issue19067@psf.upfronthosting.co.za>
Message-ID: <1380399435.24.0.0934445577978.issue19067@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

PEP8 just says "PEP 257 describes good docstring conventions."
PEP 257 is what says '''It [the one line docstring] prescribes the function or method's effect as a command ("Do this", "Return that"), not as a description; e.g. don't write "Returns the pathname ...". '''

I strongly prefer the rule, but we do not usually patch purely for PEP8 compliance. However, a docstring patch is safer than a code patch.

----------
nosy: +terry.reedy
stage:  -> patch review
versions:  -Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19067>
_______________________________________

From report at bugs.python.org  Sat Sep 28 22:37:00 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 28 Sep 2013 20:37:00 +0000
Subject: [docs] [issue19067] Built-in range docstrings are not PEP-8
	compatible
In-Reply-To: <1379833275.25.0.770459256521.issue19067@psf.upfronthosting.co.za>
Message-ID: <1380400620.78.0.799963838487.issue19067@psf.upfronthosting.co.za>


Terry J. Reedy added the comment:

I asked on py-dev whether to do this.
#19068 and #19069 are similar issues for complex and float docstrings.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19067>
_______________________________________

From report at bugs.python.org  Sat Sep 28 22:37:22 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 28 Sep 2013 20:37:22 +0000
Subject: [docs] [issue19068] Some built-in complex docstrings are not PEP-8
	compatible
In-Reply-To: <1379833742.32.0.289149108308.issue19068@psf.upfronthosting.co.za>
Message-ID: <1380400642.67.0.485257237755.issue19068@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19068>
_______________________________________

From report at bugs.python.org  Sat Sep 28 22:37:55 2013
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 28 Sep 2013 20:37:55 +0000
Subject: [docs] [issue19069] Built-in float docstrings are not PEP-8
	compatible
In-Reply-To: <1379834291.01.0.660875879281.issue19069@psf.upfronthosting.co.za>
Message-ID: <1380400675.83.0.195620362816.issue19069@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19069>
_______________________________________

From senthil at uthcode.com  Sun Sep 29 02:11:22 2013
From: senthil at uthcode.com (Senthil Kumaran)
Date: Sat, 28 Sep 2013 17:11:22 -0700
Subject: [docs] Typo in urlparse documentation
In-Reply-To: <CAMVLGWT7rF3Bmn4K5XXPNB8E_V8_ndfDBaUdEo=ettNg7tzeZQ@mail.gmail.com>
References: <CAMVLGWT7rF3Bmn4K5XXPNB8E_V8_ndfDBaUdEo=ettNg7tzeZQ@mail.gmail.com>
Message-ID: <CAPOVWOR9NOpPkm1HE41DmvXibOWMqOGQBukcckW924FybEdEOg@mail.gmail.com>

Hi Omri,

> should contain
>   "path='www.cwi.nl/%7Eguido/Python.html'"
> instead of
>   "path='www.cwi.nl:80/%7Eguido/Python.html'"


It does not matter in my opinion. Why do think think that the current
example is wrong?

Thanks,
Senthil

From report at bugs.python.org  Sun Sep 29 07:51:10 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 29 Sep 2013 05:51:10 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
In-Reply-To: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>
Message-ID: <1380433870.95.0.522868011676.issue19110@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sun Sep 29 08:09:09 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 29 Sep 2013 06:09:09 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
In-Reply-To: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>
Message-ID: <3cnbsx0RxMz7LjM@mail.python.org>


Roundup Robot added the comment:

New changeset 281608674f63 by Ned Deily in branch 'default':
Issue #19110: Suppress PEP 0 Last-Modified link in pep2pyramid, too
http://hg.python.org/peps/rev/281608674f63

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sun Sep 29 08:19:27 2013
From: report at bugs.python.org (Ned Deily)
Date: Sun, 29 Sep 2013 06:19:27 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
In-Reply-To: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>
Message-ID: <1380435567.19.0.98650766972.issue19110@psf.upfronthosting.co.za>


Ned Deily added the comment:

Thanks for the report.  The PEP 0 page now no longer contains a link: since it is automatically generated, there is no corresponding file for it in the peps repo.

----------
nosy: +ned.deily
stage:  -> committed/rejected

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sun Sep 29 09:06:42 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 29 Sep 2013 07:06:42 +0000
Subject: [docs] [issue19110] PEP-0 history link is broken
In-Reply-To: <1380357436.7.0.673838286664.issue19110@psf.upfronthosting.co.za>
Message-ID: <1380438402.53.0.179675109658.issue19110@psf.upfronthosting.co.za>


anatoly techtonik added the comment:

Cool. Even if it is automatically generated, it may worth to commit this file anyway to get browsable HG history about PEP additions/removals.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19110>
_______________________________________

From report at bugs.python.org  Sun Sep 29 11:25:58 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 29 Sep 2013 09:25:58 +0000
Subject: [docs] [issue19121] Documentation guidelines enhancements
Message-ID: <1380446758.24.0.414615784712.issue19121@psf.upfronthosting.co.za>


New submission from anatoly techtonik:

I'll raise some points and then suggest how to fix that.

issue19060 it appeared that list of functions that subprocess replaces imbues readers with uncertainty, because this list is not complete.

Current http://docs.python.org/devguide/documenting.html guide doesn't pay attention that information should be "complete and unambiguous". issue19060 is a good example of completeness requirement - user should not be left guessing what other functions can be or can not be replaced by subprocess. Unambiguous means that there should also be answer why they can or can not be replaced. For subprocess this info is partially provided in "replacing older functions" chapter. There also should not be a place for subjective judgement, fear and desperation. If something can not be done with subprocess, users should not be discouraged (left in fear) to use older functions. If there are valid points where subprocess is not good, they should be described in advanced section. If the description is too long to read, it should be linked.

Somebody may raise the point that subprocess docs is not the best place for such list. But between choice to be complete and structured, the former should take precedence. When documentation is complete enough, it's text can be restructured. This further raises a point about structure of docs. Both main docs and guidelines itself.


Main docs structure.

The more unambiguous, complete and concise documentation is, the better it is for understanding. Currently our docs really miss overviews and summaries. Some may argue that there is no place for that in official docs, especially if such summaries will contain info about history and changes between Python versions. But I'd say that if there is no place, we need to find it for them. Just two examples. MSDN and Python Cookbook both are examples of perfect documentation and these both include overview chapters before function reference. When where is a critical mass of info related to child process execution and management, it is worth to make an overview.


Guidelines structure.

ToC.
Sphinx ToCs are too narrow - they are hard to read. If ToC is present in side panel for navigation, it is not the reason not to include it below the page header for human readers to see the structure of the doc. I find it extremely hard (unnatural) to scan the side panel for the doc structure.

This should be split between markup and content guidelines. Right now the structure of docs is:

7. Documenting Python
7.1. Introduction
7.2. Style guide
7.2.1. Use of whitespace
7.2.2. Footnotes
7.2.3. Capitalization
7.2.4. Affirmative Tone
7.2.5. Economy of Expression
7.2.6. Code Examples
7.2.7. Code Equivalents
7.2.8. Audience
7.3. reStructuredText Primer
7.3.1. Paragraphs
7.3.2. Inline markup
7.3.3. Lists and Quotes
7.3.4. Source Code
7.3.5. Hyperlinks
7.3.5.1. External links
7.3.5.2. Internal links
7.3.6. Sections
7.3.7. Explicit Markup
7.3.8. Directives
7.3.9. Footnotes
7.3.10. Comments
7.3.11. Source encoding
7.3.12. Gotchas
7.4. Additional Markup Constructs
7.4.1. Meta-information markup
7.4.2. Module-specific markup
7.4.3. Information units
7.4.4. Showing code examples
7.4.5. Inline markup
7.4.6. Cross-linking markup
7.4.7. Paragraph-level markup
7.4.8. Table-of-contents markup
7.4.9. Index-generating markup
7.4.10. Grammar production displays
7.4.11. Substitutions
7.5. Differences to the LaTeX markup
7.5.1. Inline markup
7.5.2. Information units
7.5.3. Structure
7.6. Building the documentation
7.6.1. Using make
7.6.2. Without make

As you may see the 90% of the ToC is markup reference. Some topics like "Hyperlinks" are oversplit. Making two chapter for just one sentence is an obsession with structure. That's ok for coding, but for readability I would just make it into a list in one chapter, renamed to "Linking" and merged "cross-linking markup" section into it.


7.2.3. Capitalization
7.2.4. Affirmative Tone
7.2.5. Economy of Expression
7.2.6. Code Examples

As you may see, the "Content writing" is perfectly mixed with "Content formatting" into the mix of rules for proper whitespace formatting. This perfectly characterizes us coders, who often mix the concept of "good code which is bug-free" with concept of "good code which is PEP-8 compliant". I mean that it leaves expression that most of the document is about rules, regulations and nitpicking about how you should format the text, not how you should write. 

Let's make this unambiguous - "Content" of documentation is essential info that readers need to know. "Format" of docs is the markup, whitespace, examples, footnotes and other stuff. "Content guidelines" say that you should insert footnotes, "Format guidelines" show how to do this. "Content guidelines" should not distract from the content aspects.

So, the "Style Guide" should be split into "Content Writing" and "Formatting Guidelines" [ ]. Or moves into separate file at all.


The "Content Writing" chapter.
Should include chapter that docs should be complete and unambiguous, with the points raised above, probably with a link to the linked issue.

I don't get what "affirmative tone" is. I don't get it, because header "affirmative tone" for non-native non-speaker doesn't contain the answer what and why. To me chapters like "avoid uncertainty" are more concise and valid.

"Documentation is a place for facts. Make sure that facts are complete. That after reading the documentation users are not left with doubts and fears. Make sure that if is there is a recommendation, there is also a link to reasons."

"establishing confident knowledge" and "affirmative tone" are phrases from NLP psychotherapy courses. It looks like guideline to program the readers for positive emotions, not to provide them with facts. I am not saying that docs should be dry and lawfully correct. Just the focus should be on the side of facts.

I hope that this feedback is useful.

----------
assignee: docs at python
components: Devguide, Documentation
messages: 198571
nosy: docs at python, ezio.melotti, techtonik
priority: normal
severity: normal
status: open
title: Documentation guidelines enhancements

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19121>
_______________________________________

From report at bugs.python.org  Sun Sep 29 11:29:56 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 29 Sep 2013 09:29:56 +0000
Subject: [docs] [issue19060] docs: note that subprocess doesn't replace
	os.exec*
In-Reply-To: <1380396642.85.0.857227999019.issue19060@psf.upfronthosting.co.za>
Message-ID: <CAPkN8xLMS8S6eh_773ORk_joXF7Jyq_RG7uzoGrV-V+z0YC4Gw@mail.gmail.com>


anatoly techtonik added the comment:

I would like to know if the list is complete too. It would be
extremely awesome if it was complete.

This raises a side issue that there seems no guideline to write
unambiguous and complete documentation. I spammed the tracker with
this stuff in issue19121.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19060>
_______________________________________

From report at bugs.python.org  Sun Sep 29 11:32:41 2013
From: report at bugs.python.org (anatoly techtonik)
Date: Sun, 29 Sep 2013 09:32:41 +0000
Subject: [docs] [issue19060] docs: note that subprocess doesn't replace
	os.exec*
In-Reply-To: <1380396642.85.0.857227999019.issue19060@psf.upfronthosting.co.za>
Message-ID: <CAPkN8x+CzqwHM9qe1BzEiPVpzWcKKZP1AtS5RvzKF3yyAgSJ8Q@mail.gmail.com>


anatoly techtonik added the comment:

On Sat, Sep 28, 2013 at 10:30 PM, Terry J. Reedy <report at bugs.python.org> wrote:
>
> If a sentence were added, I would simplify it to
> "It does not replace os.exec*." or perhaps "os.fork and os.exec*.".

I prefer list. It is easier to scan:
http://www.nngroup.com/articles/how-users-read-on-the-web/

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19060>
_______________________________________

From report at bugs.python.org  Sun Sep 29 11:43:53 2013
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 29 Sep 2013 09:43:53 +0000
Subject: [docs] [issue19121] Documentation guidelines enhancements
In-Reply-To: <1380446758.24.0.414615784712.issue19121@psf.upfronthosting.co.za>
Message-ID: <1380447833.77.0.855308906215.issue19121@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
nosy: +rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19121>
_______________________________________

From report at bugs.python.org  Sun Sep 29 18:09:07 2013
From: report at bugs.python.org (Jason Smestad)
Date: Sun, 29 Sep 2013 16:09:07 +0000
Subject: [docs] [issue19129] 6.2.1. Regular Expression Syntax flags
Message-ID: <1380470947.27.0.0292455287204.issue19129@psf.upfronthosting.co.za>


New submission from Jason Smestad:

In the Python 3.3.2 documentation in the section "6.2.1. Regular Expression Syntax" subsection "(?aiLmsux)" it describes flags that are set by extention notation. 6 of the flags are described in detail with links for each flag, but the "u" flag is not described or linked to in this subsection. 

When reading this subsection, you may be confused as to what the "u" flag is for, or if it even belongs there, since there is no link. I suggest that a link be added in that subsection to the re.A section in 6.2.2, and that re.U be added as a title for the re.A subsection in 6.2.2.

----------
assignee: docs at python
components: Documentation
messages: 198600
nosy: docs at python, endoalir
priority: normal
severity: normal
status: open
title: 6.2.1. Regular Expression Syntax flags
versions: Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19129>
_______________________________________

From report at bugs.python.org  Sun Sep 29 18:58:41 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Sun, 29 Sep 2013 16:58:41 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
Message-ID: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>


New submission from Antoine Pitrou:

PCbuild/readme.txt mentions VS2008 while VS2010 is required to build 3.4. Am I missing something?

----------
assignee: docs at python
components: Documentation
messages: 198602
nosy: brian.curtin, docs at python, loewis, pitrou, tim.golden
priority: normal
severity: normal
status: open
title: PCbuild/readme.txt not up-to-date
type: behavior
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:00:49 2013
From: report at bugs.python.org (Christian Heimes)
Date: Sun, 29 Sep 2013 17:00:49 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
In-Reply-To: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>
Message-ID: <1380474049.61.0.209239818985.issue19130@psf.upfronthosting.co.za>


Christian Heimes added the comment:

It also mentions VS 10.0 which is 2010 ... I'm fixing it now.

----------
nosy: +christian.heimes

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:02:54 2013
From: report at bugs.python.org (Tim Golden)
Date: Sun, 29 Sep 2013 17:02:54 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
In-Reply-To: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>
Message-ID: <52485D3A.4030807@timgolden.me.uk>


Tim Golden added the comment:

Nope. Looks like a mistake. Confusingly, the header refers to VC++ 10.0 
which is VS 2010 (I think). AFAICT a global s/2008/2010/ would be the 
thing to do.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:05:34 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 29 Sep 2013 17:05:34 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
In-Reply-To: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>
Message-ID: <3cntRK61xfz7Ljc@mail.python.org>


Roundup Robot added the comment:

New changeset 69bb4bf24b07 by Christian Heimes in branch '3.3':
Issue #19130: Correct PCbuild/readme.txt, Python 3.3 and 3.4 require VS 2010
http://hg.python.org/cpython/rev/69bb4bf24b07

New changeset f5a7090e16b7 by Christian Heimes in branch 'default':
Issue #19130: Correct PCbuild/readme.txt, Python 3.3 and 3.4 require VS 2010
http://hg.python.org/cpython/rev/f5a7090e16b7

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:10:28 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 29 Sep 2013 17:10:28 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
In-Reply-To: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>
Message-ID: <3cntXz45K1z7LjX@mail.python.org>


Roundup Robot added the comment:

New changeset b602edf9b100 by Christian Heimes in branch '3.3':
Issue #19130: mention historic VS 2008 build dir, too
http://hg.python.org/cpython/rev/b602edf9b100

New changeset a16b83ff7fb1 by Christian Heimes in branch 'default':
Issue #19130: mention historic VS 2008 build dir, too
http://hg.python.org/cpython/rev/a16b83ff7fb1

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:22:01 2013
From: report at bugs.python.org (Zachary Ware)
Date: Sun, 29 Sep 2013 17:22:01 +0000
Subject: [docs] [issue19130] PCbuild/readme.txt not up-to-date
In-Reply-To: <1380473921.46.0.878582120992.issue19130@psf.upfronthosting.co.za>
Message-ID: <1380475321.14.0.139504948011.issue19130@psf.upfronthosting.co.za>


Zachary Ware added the comment:

Issue17326 can now be closed as a duplicate of this issue.

----------
nosy: +zach.ware

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19130>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:29:29 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Sun, 29 Sep 2013 17:29:29 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <1380475769.94.0.334830759854.issue19095@psf.upfronthosting.co.za>


Changes by Antoine Pitrou <pitrou at free.fr>:


----------
assignee: docs at python -> 
components: +Library (Lib) -Documentation
stage:  -> needs patch
type: enhancement -> behavior
versions: +Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:50:59 2013
From: report at bugs.python.org (Roundup Robot)
Date: Sun, 29 Sep 2013 17:50:59 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <3cnvRl1TtQz7LjQ@mail.python.org>


Roundup Robot added the comment:

New changeset ddcdf7f7eac8 by Antoine Pitrou in branch 'default':
Issue #19095: SSLSocket.getpeercert() now raises ValueError when the SSL handshake hasn't been done.
http://hg.python.org/cpython/rev/ddcdf7f7eac8

----------
nosy: +python-dev

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Sun Sep 29 19:55:16 2013
From: report at bugs.python.org (Antoine Pitrou)
Date: Sun, 29 Sep 2013 17:55:16 +0000
Subject: [docs] [issue19095] Document SSLSocket.getpeercert always returns
	None	without do_handshake
In-Reply-To: <1380151982.82.0.304891420803.issue19095@psf.upfronthosting.co.za>
Message-ID: <1380477316.82.0.486053474277.issue19095@psf.upfronthosting.co.za>


Antoine Pitrou added the comment:

Change committed in 3.4. Thanks for reporting!

----------
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19095>
_______________________________________

From report at bugs.python.org  Mon Sep 30 00:18:19 2013
From: report at bugs.python.org (Berker Peksag)
Date: Sun, 29 Sep 2013 22:18:19 +0000
Subject: [docs] [issue17326] Windows build docs still referring to VS 2008
	in 3.3
In-Reply-To: <1362142705.89.0.367756520949.issue17326@psf.upfronthosting.co.za>
Message-ID: <1380493099.33.0.802328956708.issue17326@psf.upfronthosting.co.za>


Changes by Berker Peksag <berker.peksag at gmail.com>:


----------
resolution:  -> duplicate
stage:  -> committed/rejected
status: open -> closed
superseder:  -> PCbuild/readme.txt not up-to-date

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17326>
_______________________________________

From report at bugs.python.org  Mon Sep 30 18:43:21 2013
From: report at bugs.python.org (Xavier Combelle)
Date: Mon, 30 Sep 2013 16:43:21 +0000
Subject: [docs] [issue19024] Document asterisk (*), splat or star operator
In-Reply-To: <1379251118.66.0.684713404389.issue19024@psf.upfronthosting.co.za>
Message-ID: <1380559401.51.0.58323573346.issue19024@psf.upfronthosting.co.za>


Changes by Xavier Combelle <xavier.combelle at gmail.com>:


----------
nosy: +xcombelle

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19024>
_______________________________________

From ralfganswindt at gmail.com  Wed Sep 18 13:29:14 2013
From: ralfganswindt at gmail.com (Ralf Ganswindt)
Date: Wed, 18 Sep 2013 11:29:14 -0000
Subject: [docs] Dead link "404"
Message-ID: <CAAr3Zubyi8SkK-37EP5_coT4d3UbJ1xJAeJEq1EfzQdGxiwZ_g@mail.gmail.com>

On Python manual for 2.7.5, section 24.1, "Tkinter...", the following link
is 404:
An Introduction to
Tkinter<http://www.pythonware.com/library/an-introduction-to-tkinter.htm>Fredrik
Lundh?s on-line reference material.The link appears to have been moved...
without forwarding.

Ralf Ganswindt
RalfGanswindt at gmail.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130918/6a934391/attachment-0001.html>

From murftone at gmail.com  Wed Sep 18 20:32:47 2013
From: murftone at gmail.com (Kevin Murphy)
Date: Wed, 18 Sep 2013 18:32:47 -0000
Subject: [docs] Suggestion for Python glossary
Message-ID: <96AE3A91-929A-4FFD-A4E2-9B2EB969A85F@gmail.com>

I think newbies might like having 'module' and 'package' defined in the glossary, e.g. http://docs.python.org/2/glossary.html

Just a thought.


From tarpeyjb at gmail.com  Thu Sep 19 07:08:54 2013
From: tarpeyjb at gmail.com (tarpeyjb at gmail.com)
Date: Thu, 19 Sep 2013 05:08:54 -0000
Subject: [docs] Small problem with the pop function reference
Message-ID: <CAPJ6PZ4xyZMtBCEd_=Wr54VoXK4mmUwJT8GqsYyCPKsoF=fUPw@mail.gmail.com>

In the table at
http://docs.python.org/3/library/stdtypes.html#mutable-sequence-types
s.pop([i]) is shown, which is incorrect. s.pop(i) is the proper
example:

>>> s = [1, 2, 3]
>>> s.pop([0])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'list' object cannot be interpreted as an integer

>>> s = [1, 2, 3]
>>> s.pop(0)
1

From twwinwood at gmail.com  Thu Sep 19 20:13:24 2013
From: twwinwood at gmail.com (Thomas Winwood)
Date: Thu, 19 Sep 2013 18:13:24 -0000
Subject: [docs] itertools documentation does not link to source
Message-ID: <CAEcE8Rid2i_+Y=+5DWiq9QPwrbdMY8MAZPZYo4CNzuBztkwaxw@mail.gmail.com>

Raymond Hettinger has spoken on how important it is to let people find the
source from the documentation, but there's no link from the itertools
documentation to the source.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130919/61700906/attachment-0001.html>

From joris.garonian at gmail.com  Fri Sep 20 17:07:39 2013
From: joris.garonian at gmail.com (Joris Garonian)
Date: Fri, 20 Sep 2013 15:07:39 -0000
Subject: [docs] Documentation Error
Message-ID: <CAG=ZFUR0TA03qadV6wjoYMDpsmziGnuDSEyh95OwoQ2wGEVqUQ@mail.gmail.com>

Hello,

I'm reading the documentation.

There is a problem in this part:
http://docs.python.org/3/tutorial/introduction.html#strings

Code:

print("""\Usage: thingy [OPTIONS]     -h
Display this usage message     -H hostname               Hostname to
connect to \""")

The following output (note that the initial and final newlines are not
included):

Usage: thingy [OPTIONS]
     -h                        Display this usage message
     -H hostname               Hostname to connect to


As it has been written in the documention, it should have a new line at the
bottom.

Joris Garonian
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130920/2880c86b/attachment-0001.html>

From skip at pobox.com  Fri Sep 20 17:40:17 2013
From: skip at pobox.com (Skip Montanaro)
Date: Fri, 20 Sep 2013 15:40:17 -0000
Subject: [docs] subprocess module constant documentation
Message-ID: <CANc-5UyoYFcYr_wNXNnaY3bGJeJn9MyB=iY_D-_txoWG6yt1pg@mail.gmail.com>

The subprocess module documentation mentions a lot of constants in
section 17.5.3.1. That is the only section labeled "Constants", though
it seems likely from the section hierarchy and the obscure names in
that section, that these are all Windows-specific constants. On my
Mac, I see DEVNULL, PIPE and STDOUT. While these are mentioned in
section 17.5.1, they aren't documented specifically as constants,
rather as "special value"s. I think the docs should have a single
"Constants" section one level up in the hierarchy from where it
currently live. It should describe all constants the user might
encounter, marking those which are platform-specific.

Thx,

Skip

From Cameron at phaseit.net  Mon Sep 23 21:34:02 2013
From: Cameron at phaseit.net (Cameron Laird)
Date: Mon, 23 Sep 2013 19:34:02 +0000
Subject: [docs] Minor documentation error
Message-ID: <20130923193402.GA3764@lairds.us>

<URL: http://docs.python.org/2/library/xml.etree.elementtree.html >
advises that

    ... Element.text() accesses the element's text ...

That should be

    ... Element.text accesses the element's text ...

The code sample which follows immediately after correctly illustrates
use of text as attribute, rather than method.

From Marc.Perlmutter at gdc4s.com  Wed Sep 25 14:35:21 2013
From: Marc.Perlmutter at gdc4s.com (Marc.Perlmutter at gdc4s.com)
Date: Wed, 25 Sep 2013 05:35:21 -0700
Subject: [docs] Documentation error
Message-ID: <31A5A925033707429B15A6DAC8BF48BA03943B90@AZ25EXM06.gddsi.com>

Found on:

http://docs.python.org/2.7/tutorial/datastructures.html

 

in Section 5.6. "Looping Techniques"

 

Correct the text from:

for i in reversed(xrange(1,10,2)):

 

to:

for i in reversed(range(1,10,2)):

 

Reason:

Python 2.7 does not have xrange function

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130925/4fb488a6/attachment-0001.html>

From abjimnen at aol.com  Wed Sep 25 20:45:27 2013
From: abjimnen at aol.com (abjimnen at aol.com)
Date: Wed, 25 Sep 2013 14:45:27 -0400
Subject: [docs] Else ,elif
Message-ID: <6BAB10A8-0A9B-49A3-A2E0-B8A0A77E9051@aol.com>

		I am new to programming but have been seriously been bitten by the buy and I am working with the book Python for Dummies by Stef Maruch and Aahz Maruch. I am working on a coin toss program which is suppose to  be something like   MY issue is that when I try to use the else or elif function  it comes back as SyntaxError: invalid syntax  and search as I might I can' t seem to find help to address this one issue.  And I was hoping you guys can lead me someplace to solve this.   I am using Python 3.3.2 on a Mac.
											Yours Truly 
												Roman

import random				
userinput = ' '
print "Now tossing a coin    "
while userinput.lower() != "q":
    flip = random.choice(['heads', 'tails'])
    if flip == 'heads':
        headcount+= 1
        print "heads! the number of heads is now %d" % tailcount
        else:
            tailcount += 1
            print "tails! the number of tails is now %d" % tailcount
            print "press 'Q' to quit",
            userinput = raw_input("or another key to toss again:")
            print " the total number of heads:", headcount
            print "the total number off tails:", tailcount
            

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130925/fe32e4f0/attachment-0001.html>

From kirk.strauser at kwarter.com  Thu Sep 26 20:32:26 2013
From: kirk.strauser at kwarter.com (Kirk Strauser)
Date: Thu, 26 Sep 2013 11:32:26 -0700
Subject: [docs] Typo in Python docs
Message-ID: <etPan.52447dba.6b8b4567.ad@Kirks-MacBook-Air.local>

On?http://docs.python.org/2/library/profile.html , the title of section 26.4.8. should be "Using a custom?timer", not "Using a customer?timer".?

- Kirk
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130926/b7172d27/attachment-0001.html>

From conejotambor12 at hotmail.com  Fri Sep 27 01:45:14 2013
From: conejotambor12 at hotmail.com (THE KING HARKINIAN)
Date: Thu, 26 Sep 2013 20:45:14 -0300
Subject: [docs] little bug with python.
Message-ID: <SNT146-W3CF9F04FE6015A719FDC5C9280@phx.gbl>

hello, this is my first time writing for python, i wanted to report a little bug that it makes the sound of a critical error instead the beep when i write this :

print "\a"

i'm using windows 8, and i don't know how to fix that, if you can thank you very much.


 		 	   		  
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130926/24f51469/attachment-0001.html>

From fedotovp at gmail.com  Sat Sep 28 15:31:44 2013
From: fedotovp at gmail.com (Pavel Fedotov)
Date: Sat, 28 Sep 2013 17:31:44 +0400
Subject: [docs] [bug] Another error message (documentation)
Message-ID: <CAF8hVHsAJqSwEoOdfUtkpct2rdygZbUeYwUJC2La9Mg4yA_P=w@mail.gmail.com>

Python 3.3, documentation:
http://docs.python.org/3.3/tutorial/errors.html#exceptions

First expression output another error message:

>>> 10 * (1/0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ZeroDivisionError: division by zero

(instead of ...
  File "<stdin>", line 1, in ?
ZeroDivisionError: int division or modulo by zero
that documentation reports)

-- 
Pavel Fedotov

From alex.rudy at gmail.com  Sat Sep 28 22:12:48 2013
From: alex.rudy at gmail.com (Alexander Rudy)
Date: Sat, 28 Sep 2013 13:12:48 -0700
Subject: [docs] Intersphinx Linking to Anchors in Python Docs
Message-ID: <6A5F6FCB-5436-4A67-92DE-A1A67812D152@gmail.com>

Hi,

I'm working on some documentation for the `astropy <http://astropy.org>`` project where I'd like to use inter sphinx to link to python documentation. Intersphinx creates the links without a problem, and includes anchors (I'm trying to link to the following: http://docs.python.org/library/string.html#formatstrings which I am linking with the following reST: :ref:`python:formatstrings`). However, in the redirection from this link to the final destination (http://docs.python.org/2/library/string.html) the anchor (part after the #) is lost. This feels broken. Is there something I can do, or something the python docs generation can do to fix this problem? It is annoying to send users looking for "format string syntax" to the top of the string module page. I can hardlink, but that seems silly, when I have intesrphinx. I could also always send them to the python 2 or python 3 version, but that too seems unfortunate.

Any help would be appreciated!

Thanks,
~Alex

From cclauss at bluewin.ch  Sun Sep 29 16:30:34 2013
From: cclauss at bluewin.ch (Christian Clauss)
Date: Sun, 29 Sep 2013 16:30:34 +0200
Subject: [docs] Python2orPython3 sites dormant modules as a reason not to
	move to Python3
Message-ID: <DFFCA4CA-3B16-41AF-8D92-9B5C6A5B9ABF@bluewin.ch>

https://wiki.python.org/moin/Python2orPython3 currently says:

"Popular modules that don't yet support Python 3 include Twisted (for networking and other applications), gevent (like Twisted, but different), and PIL (for processing images)."

But this obscures the reality that gevent and PIL are both dormant.  There have been no gevent updates posted to pypi for more than a year.  There have been no PIL updates in 4 years and the "friendly" fork named "Pillow" does support both Python 2 and 3 with similar or improved functionality.  The Twisted community has work to do to but is already on a path to Python 3 compatibility.    Pillow: https://pypi.python.org/pypi/Pillow/2.1.0

Python2or3 also says:
"For creating GUI applications Python 3 [...] has been supported by PyQt4 almost from the day Python 3 was released."

This will push potential users to the older PyQT4 instead of the more modern PyQT5.
https://pypi.python.org/pypi/PyQt5/5.0.1

Thanks for listening!  CCC
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130929/33d41750/attachment-0001.html>

From cclauss at bluewin.ch  Sun Sep 29 16:38:42 2013
From: cclauss at bluewin.ch (Christian Clauss)
Date: Sun, 29 Sep 2013 16:38:42 +0200
Subject: [docs] Python2orPython3 sites dormant modules as a reason not
	to move to Python3
In-Reply-To: <DFFCA4CA-3B16-41AF-8D92-9B5C6A5B9ABF@bluewin.ch>
References: <DFFCA4CA-3B16-41AF-8D92-9B5C6A5B9ABF@bluewin.ch>
Message-ID: <CDA704DA-7866-41B0-848F-25018C75F99C@bluewin.ch>

Also the gevent link should be updated to point to http://gevent.org

Sent from my iPad

> On Sep 29, 2013, at 16:30, Christian Clauss <cclauss at bluewin.ch> wrote:
> 
> https://wiki.python.org/moin/Python2orPython3 currently says:
> 
> "Popular modules that don't yet support Python 3 include Twisted (for networking and other applications), gevent (like Twisted, but different), and PIL (for processing images)."
> 
> But this obscures the reality that gevent and PIL are both dormant.  There have been no gevent updates posted to pypi for more than a year.  There have been no PIL updates in 4 years and the "friendly" fork named "Pillow" does support both Python 2 and 3 with similar or improved functionality.  The Twisted community has work to do to but is already on a path to Python 3 compatibility.    Pillow: https://pypi.python.org/pypi/Pillow/2.1.0
> 
> Python2or3 also says:
> "For creating GUI applications Python 3 [...] has been supported by PyQt4 almost from the day Python 3 was released."
> 
> This will push potential users to the older PyQT4 instead of the more modern PyQT5.
> https://pypi.python.org/pypi/PyQt5/5.0.1
> 
> Thanks for listening!  CCC
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20130929/b3ace556/attachment-0001.html>