Mailman 3 November 2010 - docs

[issue9331] sys.setprofile is not described as CPython implementation detail
by Alexander Belopolsky March 29, 2011

March 29, 2011

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: Unlike sys.settrace, sys.setprofile is not described as CPython implementation detail in Doc/library/sys.rst. ---------- assignee: docs@python components: Documentation messages: 111199 nosy: belopolsky, docs@python priority: normal severity: normal stage: needs patch status: open title: sys.setprofile is not described as CPython implementation detail type: feature request … [View More]

2 1

[issue9343] Document that argparse "parents" must be fully declared before children
by Steven Bethard March 26, 2011

March 26, 2011

New submission from Steven Bethard <steven.bethard(a)gmail.com>: [From http://code.google.com/p/argparse/issues/detail?id=61] It should be documented clearly that only the arguments present on the parent parser at the time ArgumentParser is called will be included in the parser. >>> parent = argparse.ArgumentParser(add_help=False) >>> child = argparse.ArgumentParser(parents=[parent]) >>> parent.add_argument('--foo', action='store_true') >>> child.… [View More]

3 4

[issue9362] Make exit/quit hint more novice friendly
by Alexander Belopolsky March 15, 2011

March 15, 2011

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: This bikeshed have been repainted several times already, but here is a true story. Cast: Me = myself Novice = a 14-year-old boy Laptop = a MacBook Air Novice: How do i exit [from python prompt]? Me: What's your best guess? Novice: [typing] exit [pressing Enter] Laptop: Use exit() or Ctrl-D (i.e. EOF) to exit Novice: [typing] Ctrl... Me: OMG, you don't know what Ctrl-D means? Look for the Ctrl key. Novice: … [View More]

10 27

[issue9802] Document 'stability' of builtin min() and max()
by Matthew Woodcraft March 4, 2011

March 4, 2011

New submission from Matthew Woodcraft <matthew(a)woodcraft.me.uk>: In CPython, the builtin max() and min() have the property that if there are items with equal keys, the first item is returned. From a quick look at their source, I think this is true for Jython and IronPython too. I propose making this a documented guarantee. On Python-dev, Raymond Hettinger said: << That seems like a reasonable request. This behavior has been around for a very long time is unlikely to change. … [View More]

5 8

[issue8691] Doc: left alignment is not the default for numbers
by Terry J. Reedy Feb. 7, 2011

Feb. 7, 2011

New submission from Terry J. Reedy <tjreedy(a)udel.edu>: As reported on python-list by Alan G Isaac, Lib Ref 6.1.3.1. Format Specification Mini-Language, for instance http://docs.python.org/dev/py3k/library/string.html#formatstrings wrongly says in the alignment section "'<' Forces the field to be left-aligned within the available space (This is the default.)" This latter, of course, is not true for number fields. "(This is the default.)" could be replaced by "(the string default)… [View More]

4 5

[issue9723] pipes.quote() needs to be documented
by Brandon Craig Rhodes Jan. 22, 2011

Jan. 22, 2011

New submission from Brandon Craig Rhodes <brandon(a)rhodesmill.org>: The only way to safely build shell command lines from inside of Python — which is necessary when sending commands across SSH, since that behaves like os.system() rather than like subprocess.call() — is to use the wonderful pipes.call() method to turn possibly-dangerous arguments, like filenames that might have spaces, special characters, and embedded "rm -r" calls, into perfectly quoted strings for an "sh"-like shell (… [View More]

4 6

[issue10357] ** and "mapping" are poorly defined in python docs
by Fergal Daly Jan. 8, 2011

Jan. 8, 2011

New submission from Fergal Daly <fergald(a)gmail.com>: According to the index, the only place that mentions ** in argument lists is http://docs.python.org/tutorial/controlflow.html#index-1099 and gives no indication of what an object must support to allow **. When you attempt to ** an object the real attribute exception is suppressed and you get a message "argument after ** must be a mapping" "mapping" is quite loosely defined. There are 3 definitions, the glossary entry seems the … [View More]

4 6

[issue9717] operator module - "in place" operators documentation
by Arnaud Delobelle Jan. 8, 2011

Jan. 8, 2011

New submission from Arnaud Delobelle <arnodel(a)googlemail.com>: More detailed explanation of how in place operators work, and how they are related to the operator module iadd, isub, ... functions. Submitted following this message on python-list: http://mail.python.org/pipermail/python-list/2010-August/1254243.html ---------- assignee: docs@python components: Documentation files: operator_inplace.diff keywords: patch messages: 115237 nosy: arno, docs@python priority: normal severity: … [View More]

3 6

[issue9370] Add reader redirect from test package docs to unittest module
by Nick Coghlan Jan. 1, 2011

Jan. 1, 2011

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: Brett updated the docs for the test package to (correctly) point out that it is our internal testing package and isn't subject to the same stringent backwards compatibility rules as the rest of the standard library. A "see also" link pointing readers that have landed there over to the unittest module for their testing infrastructure needs would be a friendly thing to include. ---------- assignee: docs@python components: … [View More]

3 3

[issue9891] Minor doc typo at datamodel.rst: "list" -> "alist"
by Rodrigo Bernardo Pimentel Dec. 26, 2010

Dec. 26, 2010

New submission from Rodrigo Bernardo Pimentel <rbp(a)isnomore.net>: The "Built-in methods" item of the "The standard type hierarchy" section of Doc/reference/datamodels.rst uses a list instance called "alist" as an example, and it says "__self__ is set to the object denoted by *list*." It should read "the object denoted by *alist*" This affects all releases, so I've marked them all. But I suppose we don't care about 2.5 anymore. All the others are listed on docs.python.org (or are "… [View More]

2 3