Mailman 3 October 2010 - docs

[issue8645] PyUnicode_AsEncodedObject is undocumented
by Daniel Stutzbach 20 Nov '10

20 Nov '10

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: PyUnicode_AsEncodedObject is undocumented. It has the same signature as PyUnicode_AsEncodedString, although they do slightly different things based on a brief source code inspection (I'm not clear on what that difference is though). ---------- assignee: docs@python components: Documentation messages: 105203 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: PyUnicode_AsEncodedObject is undocumented versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8645> _______________________________________

4 5

[issue8649] Py_UNICODE_* functions are undocumented
by Daniel Stutzbach 16 Nov '10

16 Nov '10

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: Python provides several functions for manipulating raw Py_UNICODE strings, but they aren't documented. Below are their signatures. PyAPI_FUNC(size_t) Py_UNICODE_strlen(const Py_UNICODE *u); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strcpy( Py_UNICODE *s1, const Py_UNICODE *s2); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strncpy( Py_UNICODE *s1, const Py_UNICODE *s2, size_t n); PyAPI_FUNC(int) Py_UNICODE_strcmp( const Py_UNICODE *s1, const Py_UNICODE *s2); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strchr( const Py_UNICODE *s, Py_UNICODE c ); ---------- assignee: docs@python components: Documentation messages: 105214 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: Py_UNICODE_* functions are undocumented versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8649> _______________________________________

5 5

[issue10008] Two links point to same place
by Hirokazu Yamamoto 11 Nov '10

11 Nov '10

New submission from Hirokazu Yamamoto <ocean-city(a)m2.ccsnet.ne.jp>: Please see http://docs.python.org/genindex-T.html Thread (class in threading), [1] This two links point to same place. I think latter should point http://docs.python.org/library/threading.html#thread-objects or class threading.Thread(group=None, target=None, name=None, args=(), kwargs={}) bellow. # Latter doesn't have perma link. ---------- assignee: docs@python components: Documentation messages: 117824 nosy: docs@python, ocean-city priority: normal severity: normal status: open title: Two links point to same place versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10008> _______________________________________

3 10

[issue10226] urlparse example is wrong
by Alexander Belopolsky 07 Nov '10

07 Nov '10

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: The following example in Doc/library/urlparse.rst is wrong >>> urlparse('www.cwi.nl:80/%7Eguido/Python.html') ParseResult(scheme='', netloc='', path='www.cwi.nl:80/%7Eguido/Python.html', params='', query='', fragment='') In the actual output, scheme='www.cwi.nl'. In addition, the preceding text is confusing and probably not grammatical: """ Otherwise, it is not possible to distinguish between netloc and path components, and would the indistinguishable component would be classified as the path as in a relative URL. """ Discovered while working on issue 10225. ---------- assignee: docs@python components: Documentation messages: 119855 nosy: belopolsky, docs@python priority: normal severity: normal status: open title: urlparse example is wrong versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10226> _______________________________________

5 10

[issue10145] (4.2).is_integer() is undocumented.
by Ralph Corderoy 07 Nov '10

07 Nov '10

New submission from Ralph Corderoy <ralph-pythonbugs(a)inputplus.co.uk>: floats now have an is_integer() method. I think it was added in 2.6 around the same time as as_integer_ratio(). It has a docstring but it isn't mentioned in the documentation. I only idled across it when reading the C source. I'd expect to find it, for example, at http://docs.python.org/library/stdtypes.html?highlight=as_integer_ratio#add… http://docs.python.org/py3k/library/stdtypes.html?highlight=as_integer_rati… Can it please be added, and for Py2, mention what version it appeared in. ---------- assignee: docs@python components: Documentation messages: 119133 nosy: docs@python, ralph.corderoy priority: normal severity: normal status: open title: (4.2).is_integer() is undocumented. versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10145> _______________________________________

4 4

[issue10038] Returntype of json.loads() on strings
by Nik Tautenhahn 02 Nov '10

02 Nov '10

New submission from Nik Tautenhahn <nik(a)livinglogic.de>: Hi, before 2.7, an import json json.loads('"abc"') yielded u"abc". in 2.7 I get "abc" (a byte string). I would have expected an entry in "news" or "What's new in 2.7" why this change happened. In addition, all examples at http://docs.python.org/library/json are wrong for Python 2.7 if json.loads is involved. Any insight on this? best regards, Nik ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 118069 nosy: docs@python, llnik priority: normal severity: normal status: open title: Returntype of json.loads() on strings type: behavior versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10038> _______________________________________

7 20

Typo in 16.6.1.1.
by Sebastian Zug 01 Nov '10

01 Nov '10

Dear Python documentation team, on page http://docs.python.org/library/multiprocessing.html in chapter "16.6.1.1. The Process class" there is a obvious typo inside the second code example in line 7 from multiprocessing import Process import os def info(title): print title print 'module name:', __name__ print 'parent process:', os.getppid() <-- it means os.getpid() print 'process id:', os.getpid() def f(name): info('function f') print 'hello', name if __name__ == '__main__': info('main line') p = Process(target=f, args=('bob',)) p.start() p.join() Best wishes from Germany Enjoy the weekend Sebastian -- ------------------------------------------------------------- Dipl. Ing. Sebastian Zug Dept. Embedded Systems and Operating Systems (EOS) Institute for Distributed Systems (IVS) Otto-von-Guericke-University of Magdeburg Universitätsplatz 2 39106 Magdeburg Germany mail: zug(a)ivs.cs.uni-magdeburg.de Tel.: +49 - 391 - 67 - 11459 Fax: +49 - 391 - 67 - 11161

2 1

[issue9886] Make operator.itemgetter/attrgetter/methodcaller easier to discover
by Nick Coghlan 31 Oct '10

31 Oct '10

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: The observation has been made that there are some idioms related to key functions passed to various methods and functions that aren't particularly easy to discover. One suggestion is to create a "key function" glossary entry that provides examples of standard library operations that exist primarily for use as key functions (i.e. the three functions mentioned in the issue title), as well as mentioning some of the APIs that accept key functions (e.g. sorted, list.sort, min, max). The documentation of these various could then cross link to the "key function" glossary entry to make this idioms more discoverable without needing to repeat ourselves in the documentation of every method that accepts a key function. As per discussion on python-ideas, including the glossary entry suggestion from Terry Reedy: http://mail.python.org/pipermail/python-ideas/2010-September/008093.html ---------- assignee: docs@python components: Documentation messages: 116658 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Make operator.itemgetter/attrgetter/methodcaller easier to discover versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9886> _______________________________________

3 3

[issue7447] Sum() doc and behavior mismatch
by Raymond Hettinger 31 Oct '10

31 Oct '10

Raymond Hettinger <rhettinger(a)users.sourceforge.net> added the comment: Fixed in r86066, r86068 and r86069. ---------- resolution: -> fixed status: open -> closed versions: -Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7447> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Terry J. Reedy 30 Oct '10

30 Oct '10

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: GREGOR, I think we need your help to answer a few of these. Subissues from my opening post not resolved in rev85732 -------------------- "version of python installed with Tk support.": cap 'python' to 'Python' Is there any standard on capitalizing 'Python'? ----------- 24.5.3.1. Turtle motion ?? distance units? pixel or world, depending on mode? presume yes, but should say something here. -------------- I said ''' "turtle.onclick(fun, btn=1, add=None) It seems that 'add=False' would be same as 'add=None' and more consistent with below. "add – True or False – if True, a new binding will be added, otherwise it will replace a former binding " ''' In declining to make a change, you said " The add argument is passed unchanged to canvas' bind method which is documented as taking either '' or '+' string:" However, naive users are not supposed to know that, which is why you moved turtle doc out of tk chapter. Anyway, one has to know or guess to look for the doc on the generic widget bind method. There still remains a discrepancy between signature and following doc. If you do not want to change the signature, change the doc. Anyway, the sentence needs to be expanded so it makes sense without reading the generic tkinter bind doc. ""add – True, False, or None - if True, add the new binding to any that already exist, otherwise replace all former bindings with the new one." Same change is needed for onrelease and ondrag ---------------------- You changed the title "Excursus about the use of compound shapes" to "Compound shapes" but did not, as far as I can see, make the same change in the reference in *24.5.5. The public classes of the module turtle* after "addcomponent(poly, fill, outline=None)" Also, the above should actually be "class turtle.addcomponent(poly, fill, outline=None)" to be consistent with the other entries ---------------------------- ''' 24.5.4. Methods of TurtleScreen/Screen and corresponding functions "Most of the examples in this section refer to a TurtleScreen instance called screen." However, 24.5.4.1. Window control turtle.bgcolor(*args) " and so on throughout the section. ?? I presume that should be "screen.bgcolor(*args)" and so on throughout the section. ''' Not addressed as far as I can see. ------------------------ .delay vs. speed is #10170 ------------ ''' "Remark: in order to be able to register key-events, TurtleScreen must have the focus. (See method listen(). >>> def f(): ... fd(50) ... lt(60) ... >>> screen.onkey(f, "Up") >>> screen.listen()" >From the Remark, I expected the two calls to be in the opposite order. Ditto for .onkeypress() ''' Since the .listen doc says "Set focus on TurtleScreen (in order to collect key-events). ", I strongly suspect that 'register' in the remark should be changed to 'collect', 'capture', or 'respond to' for both onkeypress and onkeyrelease. Then the example is correct. --------------- The last 3 sub-issues are still open ''' 24.5.4.5. Settings and special methods ?? .mode: 'world' like standard or logo w/r/t angles? ''' ''' "24.5.4.6. Methods specific to Screen, not inherited from TurtleScreen turtle.exitonclick() Bind bye() method to mouse clicks on the Screen." "If the value “using_IDLE” in the configuration dictionary is False (default value), also enter mainloop. Remark: If IDLE with the -n switch (no subprocess) is used, this value should be set to True in turtle.cfg. In this case IDLE’s own mainloop is active also for the client script." >From Windows shortcut, I cannot tell how IDLE is started, but seems to work. Anything need to be said re IDLE/turtle on windows? My guess is that IDLE is running normally (without -n), so that there is a subprocess, so that 'using_IDLE' is False even though I am using it, just not in the same process. Correct? ''' ''' 24.5.8. Changes since Python 2.6 Sections about 2.x changes should not be in 3.x docs. ''' ----------------------- Thanks for the other half that are fixed! ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

2 1