Commit graph

206 commits

Author SHA1 Message Date
Andrew M. Kuchling
2a927915cb Backport doc changes from rev. 53112, 53115: use 'iterable' in various
places instead of 'sequence'.
2006-12-20 20:15:08 +00:00
Georg Brandl
bdbb9c62de Bug #1575746: fix typo in property() docs.
(backport from rev. 52293)
2006-10-12 07:38:08 +00:00
Fred Drake
e0d4aecfc2 lots of markup nits, most commonly Unix/unix --> \UNIX 2006-07-30 03:03:43 +00:00
Andrew M. Kuchling
956597f4ef Reorganize the docs for 'file' and 'open()' after some discussion with Fred.
We want to encourage users to write open() when opening a file, but
open() was described with a single paragraph and
'file' had lots of explanation of the mode and bufsize arguments.

I've shrunk the description of 'file' to cross-reference to the 'File
objects' section, and to open() for an explanation of the arguments.

open() now has all the paragraphs about the mode string.  The bufsize
argument was moved up so that it isn't buried at the end; now there's
1 paragraph on mode, 1 on bufsize, and then 3 more on mode.  Various
other edits and rearrangements were made in the process.

It's probably best to read the final text and not to try to make sense
of the diffs.
2006-07-29 18:14:07 +00:00
Georg Brandl
d41f4ce0c8 no need to elaborate "string". 2006-07-05 15:50:05 +00:00
Georg Brandl
f41beacecb Patch #1517490: fix glitches in filter() docs. 2006-07-05 14:18:45 +00:00
Andrew M. Kuchling
2eda1b78f9 [Bug #1511911] Clarify description of optional arguments to sorted()
by improving the xref to the section on lists, and by
   copying the explanations of the arguments (with a slight modification).
2006-07-03 14:16:09 +00:00
Fred Drake
6f42dfce7c - consistency nit: always include "()" in \function and \method
(*should* be done by the presentation, but that requires changes all over)
- avoid spreading the __name meme
2006-06-30 19:29:25 +00:00
Georg Brandl
348b7c8304 Document decorator usage of property. 2006-06-30 18:47:56 +00:00
Georg Brandl
7b90e168f3 Bug #1462152: file() now checks more thoroughly for invalid mode
strings and removes a possible "U" before passing the mode to the
C library function.
2006-05-18 07:01:27 +00:00
Neal Norwitz
c4edb0ec81 SF #1479181: split open() and file() from being aliases for each other. 2006-05-02 04:43:14 +00:00
Neal Norwitz
92e212f7d9 Accept keyword arguments for __import__ and doc the addition of the level param from PEP 328. 2006-04-03 04:48:37 +00:00
Georg Brandl
b227bea292 object() is a function, not a base class. 2006-03-31 15:07:25 +00:00
Georg Brandl
48b4bf7b1a Add a note about pow(x,y) equalling x**y (the "**" operator
was used unmotivated in the pow() docs)
2006-03-21 08:48:04 +00:00
Georg Brandl
533ff6fc06 Patch #1434038: property() now uses the getter's docstring if there is
no "doc" argument given. This makes it possible to legitimately use
property() as a decorator to produce a read-only property.
2006-03-08 18:09:27 +00:00
Georg Brandl
87b90adc28 Patch #1410783: add documentation links for static/classmethod 2006-01-20 21:33:54 +00:00
Georg Brandl
a635fbbcb0 Remove dots in \version{changed,added} argument and
correct argument order.
2006-01-15 07:55:35 +00:00
Raymond Hettinger
76fb6d84d0 SF bug #1100368: Wrong "type()" syntax in docs
Docs were missing the name/bases/dict form of type().

(Much of the wording contributed by Steven Bethard.)
2005-08-24 07:06:25 +00:00
Fred Drake
b406905f33 ord() documentation update; this is what remains applicable from
SF patch #1057588; other changes make the rest of the patch out of date
or otherwise unnecessary
2005-08-23 04:33:29 +00:00
Raymond Hettinger
1823ae7e36 SF bug #1121416: zip incorrectly and incompletely documented
sequences ==> iterables
2005-08-21 11:58:06 +00:00
Georg Brandl
b370059233 bug [ 1250306 ] incorrect description of range function 2005-08-03 07:17:33 +00:00
Georg Brandl
08c02dbb85 [ 1243081 ] repair typos 2005-07-22 18:39:19 +00:00
Georg Brandl
e21d9ab342 bug [ 1175022 ] property example code error 2005-06-25 20:07:36 +00:00
Raymond Hettinger
dede3bdfa1 SF bug #1209411: divmod documentation shd reference // not / 2005-05-31 11:04:00 +00:00
Fred Drake
b141cd03a1 fix description of the input range of unichr()
(closes SF bug #1120777)
2005-05-25 05:39:36 +00:00
Raymond Hettinger
582ffe21c4 Fill-in missing argspec. 2005-03-19 16:27:33 +00:00
Raymond Hettinger
96229b1918 Add two new functions, any() and all(). 2005-03-11 06:49:40 +00:00
Raymond Hettinger
72b83c86a9 SF patch 1094011: Docs for file() vs open(). 2005-01-07 04:33:44 +00:00
Raymond Hettinger
68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Andrew M. Kuchling
07b28b920e Hyphenate 'one-argument' 2004-12-03 14:59:09 +00:00
Raymond Hettinger
3b0c7c20a1 SF patch #1077353: add key= argument to min and max
(First draft of patch contributed by Steven Bethard.)
2004-12-03 08:30:39 +00:00
Raymond Hettinger
f751fa6195 SF bug #1035279: hex() and oct() documentation is incorrect
* Updated docs to reflected signed return values.
* Fixed a doubled word typo.
2004-09-30 00:59:08 +00:00
Martin v. Löwis
8d494f3241 Patch #1015021: Stop claiming that coerce can return None.
Will backport to 2.3.
2004-08-25 10:42:41 +00:00
Raymond Hettinger
cb40ba1f5e SF bug #805304: super instances don't support item assignment
Document a nuance of super().  It is designed to work well with dotted
attribute lookup but not with equivalent implicit lookups using operators
or statements.
2004-08-17 02:21:45 +00:00
Andrew M. Kuchling
24884a5ccc [Patch #1005465] Markup tweaks 2004-08-09 17:36:56 +00:00
Tim Peters
feec4533e2 Bug 1003935: xrange overflows
Added XXX comment about why the undocumented PyRange_New() API function
is too broken to be worth the considerable pain of repairing.

Changed range_new() to stop using PyRange_New().  This fixes a variety
of bogus errors.  Nothing in the core uses PyRange_New() now.

Documented that xrange() is intended to be simple and fast, and that
CPython restricts its arguments, and length of its result sequence, to
native C longs.

Added some tests that failed before the patch, and repaired a test that
relied on a bogus OverflowError getting raised.
2004-08-08 07:17:39 +00:00
Matthias Klose
4c8fa42aca Doc/lib/libfuncs.tex: correct items in itemize
Doc/dist/dist.tex: avoid uncommenting the verbose environment (by the py2texi tool)
2004-08-04 23:18:49 +00:00
Raymond Hettinger
70fcdb8be0 Document general mappings for the locals argument for exec and execfile(). 2004-08-03 05:17:58 +00:00
Anthony Baxter
c2a5a63654 PEP-0318, @decorator-style. In Guido's words:
"@ seems the syntax that everybody can hate equally"
Implementation by Mark Russell, from SF #979728.
2004-08-02 06:10:11 +00:00
Raymond Hettinger
f9fd0d7988 SF bug #997533: "disjunct" should be "disjoint"
* Use plain wording in docs for id().
* Use normal quotation marks instead of single quotes in the description.
2004-07-29 06:06:34 +00:00
Raymond Hettinger
214b1c3aae SF Bug #215126: Over restricted type checking on eval() function
The builtin eval() function now accepts any mapping for the locals argument.
Time sensitive steps guarded by PyDict_CheckExact() to keep from slowing
down the normal case.  My timings so no measurable impact.
2004-07-02 06:41:07 +00:00
Brett Cannon
0fefc140aa Fix small grammatical mistake. 2004-05-05 16:49:11 +00:00
Skip Montanaro
20a8336ff7 concrete example of why retaining old objects is good 2004-03-21 16:05:30 +00:00
Raymond Hettinger
fe703e0650 SF bug #918371: hasattr()'s return type
Replace 1 and 0 with True and False.
2004-03-20 18:25:31 +00:00
Skip Montanaro
8e6ad6fbe9 Expand on the semantics of reload(). Closes #919099. 2004-03-19 15:20:16 +00:00
Fred Drake
fcadf6bdaf fix reference to File Object documentation
closes SF bug #825810
2004-01-01 03:41:27 +00:00
Fred Drake
dcf32a676e fix markup errors 2003-12-30 20:48:59 +00:00
Andrew M. Kuchling
7a3786cc55 [Bug #857821] Remove mention of deprecated string.{atol,atof} functions. (Patch from Gerrit Holl) 2003-12-23 16:53:34 +00:00
Raymond Hettinger
64958a15d7 Guido grants a Christmas wish:
sorted() becomes a regular function instead of a classmethod.
2003-12-17 20:43:33 +00:00
Raymond Hettinger
e3d5f98180 Put str() in alphabetical order. 2003-12-07 11:24:03 +00:00