Mailman 3 January 2011 - docs

tuple or struct_time
by Alexander Belopolsky Jan. 3, 2011

Jan. 3, 2011

Functions in the time module that expect broken down time are currently documented as accepting "tuple or struct_time". For example, http://docs.python.org/py3k/library/time.html#time.strftime However, in recent versions, ".. or struct_time" is redundant because >>> issubclass(time.struct_time, tuple) True I think it would be more informative for a reader to change "tuple or struct_time" to "9-tuple".

2 3

[issue10818] pydoc: refactorize duplicate DocHandler and DocServer classes
by STINNER Victor Jan. 3, 2011

Jan. 3, 2011

New submission from STINNER Victor <victor.stinner(a)haypocalc.com>: The pydoc module has two DocHandler classes and two DocServer classes. I think that they can be easily factorized. DocServer may also use serve_forever()+shutdown() instead of serve_until_quit()+quit flag, to be able to wait the server (with shutdown()). ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 125190 nosy: docs@python, haypo priority: normal severity: normal status: open … [View More]

1 1

http://docs.python.org/library/random.html
by Kristoffer Lundgren Jan. 3, 2011

Jan. 3, 2011

Hi, I suspect I've found a documentation error in the above mentioned link ( http://docs.python.org/library/random.html); regarding random.randint(a, b), the documentation says "Return a random integer N such that a <= N <= b", however when actually using the function, it does seem to be a <= N < b. Running Python 2.6, the built-in help returns Type: builtin_function_or_method Base Class: <type 'builtin_function_or_method'> String Form: <built-in method … [View More]

3 2

[issue1665333] Documentation missing for OptionGroup class in optparse
by Georg Brandl Jan. 2, 2011

Jan. 2, 2011

Georg Brandl <georg(a)python.org> added the comment: Looks good, applied in r87627 (after removing stray tabs). ---------- nosy: +georg.brandl resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1665333> _______________________________________

1 0

[issue1665333] Documentation missing for OptionGroup class in optparse
by Sandro Tosi Jan. 2, 2011

Jan. 2, 2011

Sandro Tosi <sandro.tosi(a)gmail.com> added the comment: Could someone give a look to this patch? I can work on fixing the missing stuff (if any :)). ---------- stage: -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1665333> _______________________________________

1 0

[issue8350] Document lack of support for keyword arguments in C functions
by Georg Brandl Jan. 2, 2011

Jan. 2, 2011

Georg Brandl <georg(a)python.org> added the comment: Hmm, it may indeed be the best option to add a new directive option to say "this function does not take keyword args". It would result in some form of unobtrusive but noticeable output in HTML. It is a bit of an effort to add it everywhere it's necessary, but the most important instances (e.g. string methods) can be covered quickly, and it's fairly easy to grep the other instances (namely, grepping for METH_O and METH_VARARGS without … [View More]

3 2

[issue8350] Document lack of support for keyword arguments in C functions
by Terry J. Reedy Jan. 2, 2011

Jan. 2, 2011

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: If there is no indication in the lib manual as to which parameter names and defaults are real and which are fake, then the safe guideline is to never use keywards for library functions and methods and always pass everything positionally. Slightly more complicated is to be aware of which classes and modules are Python versus C coded. (If needed, change for module.py in /Lib.) For some modules, one can take a cue from doc examples … [View More]

1 0

[issue8350] Document lack of support for keyword arguments in C functions
by Terry J. Reedy Jan. 2, 2011

Jan. 2, 2011

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: I think that the warning that things are not always as they seem should be repeated in the front of the library manual where the pseudo-arg names are actual used, so the library manual stands on its own. In any case, I believe a lot of people use the lib ref without reading and remembering every detail of the language ref. ---------- nosy: +terry.reedy versions: -Python 2.6 _______________________________________ Python tracker &… [View More]

1 0

[issue8350] Document lack of support for keyword arguments in C functions
by Raymond Hettinger Jan. 2, 2011

Jan. 2, 2011

Raymond Hettinger <rhettinger(a)users.sourceforge.net> added the comment: This is an implementation detail specific to CPython and subject to change. I'm -1 on documenting it for every function/method and thereby making it part of the language spec. We've lived without this spec for almost twenty years, so I'm inclined to think it is truly unimportant. It is sufficient to mention just once in the docs that CPython functions/methods sometimes don't take keywords. ---------- nosy: +… [View More]

1 0

[issue8350] Document lack of support for keyword arguments in C functions
by Georg Brandl Jan. 2, 2011

Jan. 2, 2011

Georg Brandl <georg(a)python.org> added the comment: Yes. It's still an important detail; the explanation could say, "In CPython, this function does not take keyword args" and furthermore it's not really clear to me how much of the library reference applies to all Python implementations anyway. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8350> _______________________________________

1 0