Commit Graph

2517 Commits

Author SHA1 Message Date
Barry Warsaw 5db478fa29 Proofread and spell checked, all except the Examples section (which
I'll do next).
2002-10-01 04:33:16 +00:00
Barry Warsaw 5b9da893d3 Vast update to email version 2. This could surely use proofreading. 2002-10-01 01:05:52 +00:00
Fred Drake 2ca041fde0 items(): New method, provided by Gustavo Niemeyer in SF bug #545096. 2002-09-27 15:49:56 +00:00
Fred Drake 4613876ee3 Add deprecation notices to the documentation to reflect recent additions to
PEP 4.
2002-09-25 22:13:27 +00:00
Fred Drake 3e930ba55f Another try at clarifying what goes into and comes out of Unicode objects. 2002-09-24 21:08:37 +00:00
Fred Drake 36c2bd8e34 Remove spurious period. 2002-09-24 15:32:04 +00:00
Fred Drake 7b788e0582 Clarify that len() of a Unicode string returns the number of storage units,
not abstract characters.
2002-09-24 13:57:21 +00:00
Greg Ward 02669a35bc Tweak description of PortableUnixMailbox: "From " lines are actually
quoted (or mangled) *at* delivery-time, not "well before" it.  (At least
that's how Exim and qmail work.)
2002-09-23 19:32:42 +00:00
Thomas Heller c687401337 Fix typos: despatcher -> dispatcher. 2002-09-17 15:19:12 +00:00
Fred Drake c1ddc505d9 Minor revision to the "\\" patch, including updating the docs a little to
accomodate the fact that they are more general now that they are for the
os.path module and not just posixpath.

This and the previous patch should be combined and applied to the 2.2-maint
branch.
2002-09-12 18:01:26 +00:00
Skip Montanaro c12909bcc6 add note about os.path.join and drive letters on Windows. 2002-09-12 17:39:56 +00:00
Fred Drake b7c1895ec5 Fix typo reported by Paul Clifford.
Note that there is no str.joinfields(), use str.join() instead.
2002-09-12 14:16:07 +00:00
Fred Drake 73e8ebfc5a Revise text about the level of DOM support, and provide pointers to
the work of the XML-SIG in the main body of the text.

Modify the markup in a few places to avoid wrapping lines in bad
places, and just general cleanliness.
2002-09-11 22:03:47 +00:00
Martin v. Löwis 504bc4f3b7 Remove mentioning of Python 2.0 limitations. Fixes #607783. 2002-09-11 16:26:03 +00:00
Fred Drake 691fb55dd2 Clarify who maintains Tkinter and who maintains Tk. 2002-09-10 21:59:17 +00:00
Martin v. Löwis a32c994129 Always generate floats for stat_result; fix configure test. 2002-09-09 16:17:47 +00:00
Martin v. Löwis 94717ed1d4 Patch #606592: Subsecond timestamps in stat_result. 2002-09-09 14:24:16 +00:00
Raymond Hettinger 8a64d40949 Fix typo. Close SF Bug 606354. 2002-09-08 22:26:13 +00:00
Skip Montanaro 2c0d3224fc tightened up the definition of \b and \B some more based upon discussion
after the last checkin.
2002-09-07 18:48:14 +00:00
Walter Dörwald 5ccaf8f129 Apply diff3.txt (plus additional documentation)
from SF patch http://www.python.org/sf/554192

This adds two new functions to mimetypes:
guess_all_extensions() which returns a list of all known
extensions for a mime type, and add_type() which adds one
mapping between a mime type and an extension.
2002-09-06 16:15:58 +00:00
Skip Montanaro 2c519981fb update docs to reflect that \b considers underscore to be part of a word. 2002-09-06 14:38:23 +00:00
Raymond Hettinger d918884bb8 Fix typo 2002-09-04 23:52:42 +00:00
Raymond Hettinger a04c3d86ae Fix typo 2002-09-04 15:12:07 +00:00
Skip Montanaro 8e790e7007 expose PYTHON_API_VERSION macro as sys.api_version. Closes patch # 601456. 2002-09-03 13:25:17 +00:00
Walter Dörwald 3aeb632c31 PEP 293 implemention (from SF patch http://www.python.org/sf/432401) 2002-09-02 13:14:32 +00:00
Michael W. Hudson 53d58bb369 Further SET_LINENO reomval fixes. See comments in patch #587933.
Use a slightly different strategy to determine when not to call the line
trace function.  This removes the need for the RETURN_NONE opcode, so
that's gone again.  Update docs and comments to match.

Thanks to Neal and Armin!

Also add a test suite.  This should have come with the original patch...
2002-08-30 13:09:51 +00:00
Raymond Hettinger 9240be2a35 Note change in behavior from 1.5.2. The new argument to NameError is
an error message and not just the missing name.

Closes SF Bug 599869.
2002-08-27 23:53:23 +00:00
Fred Drake 80a04a4894 Add strong security warning about the rexec module.
Closes SF patch #600861.

Minor markup changes.
2002-08-27 16:46:06 +00:00
Tim Peters ea76c98014 Implemented <, <=, >, >= for sets, giving subset and proper-subset
meanings.  I did not add new, e.g., ispropersubset() methods; we're
going nuts on those, and, e.g., there was no "friendly name" for
== either.
2002-08-25 18:43:10 +00:00
Raymond Hettinger 7ad09552d0 Correct documentation of allow_reuse_address to match the actual script.
Closes SF bug 599681.
2002-08-25 16:27:33 +00:00
Raymond Hettinger e87ab3fefe Removed < <= > >= from the API. Implemented as comparisons of the
underlying dictionaries, there were no reasonable use cases (lexicographic
sorting of a list of sets is somewhat esoteric).  Frees the operators
for other uses (such as strict subset and superset comparisons).

Updated documentation and test suite accordingly.
2002-08-24 07:33:06 +00:00
Fred Drake 055be47b43 Fix typo reported to python-docs. 2002-08-23 21:19:53 +00:00
Raymond Hettinger fa8dd5f407 Fix markup and punctuation 2002-08-23 18:10:54 +00:00
Tim Peters b81b252fab s/_as_Temporarily_Immutable/_as_temporarily_immutable/g, because the
latter is what the code actually does.
2002-08-23 17:48:23 +00:00
Tim Peters 54fd3e6ffc pop(): An arbitrary element is removed, not a random element. 2002-08-23 17:45:43 +00:00
Fred Drake d10c6c949a Adjust the markup in a few places so this will actually format.
Remove the third column in the tables since it isn't used.
2002-08-23 17:22:36 +00:00
Raymond Hettinger 584cb198f7 Load docs for sets.py 2002-08-23 15:18:38 +00:00
Fred Drake 5ec486b87a Add a note that apply() is needed since the extended call syntax is
completely equivalent.
2002-08-22 14:27:35 +00:00
Fred Drake 61cf4407be Added a main() function and support to run this module as a script.
Closes SF feature request #588768.
2002-08-21 20:56:21 +00:00
Fred Drake 5b09eeea89 Clarify that even though some of the relevant specifications define the
order in which form variables should be encoded in a request, a CGI script
should not rely on that since a client may not conform to those specs, or
they may not be relevant to the request.
Closes SF bug #596866.
2002-08-21 19:24:21 +00:00
Fred Drake ffefb1df56 Clarify the endpos argument to the rx.match() method.
Closes SF bug #597177.
2002-08-20 13:57:47 +00:00
Neal Norwitz 11b795cd0f Add versionadded for operator.pow 2002-08-19 22:38:01 +00:00
Fred Drake 017778332f Extend some comments on the order of values in the returns from
dict.items/keys/values/iteritems/iterkeys/itervalues().
2002-08-19 21:58:58 +00:00
Guido van Rossum 45ec02aed1 SF patch 576101, by Oren Tirosh: alternative implementation of
interning.  I modified Oren's patch significantly, but the basic idea
and most of the implementation is unchanged.  Interned strings created
with PyString_InternInPlace() are now mortal, and you must keep a
reference to the resulting string around; use the new function
PyString_InternImmortal() to create immortal interned strings.
2002-08-19 21:43:18 +00:00
Raymond Hettinger 5959c559df Added __pow__(a,b) to the operator module. Completes the pattern of
all operators having a counterpart in the operator module.

Closes SF bug #577513.
2002-08-19 03:19:09 +00:00
Michael W. Hudson dd32a91cc0 This is my patch
[ 587993 ] SET_LINENO killer

Remove SET_LINENO.  Tracing is now supported by inspecting co_lnotab.

Many sundry changes to document and adapt to this change.
2002-08-15 14:59:02 +00:00
Barry Warsaw b8c20a723f More updates describing FutureWarnings. 2002-08-14 16:40:54 +00:00
Tim Peters 2f238c1b22 mkstemp's last argument changed from binary=True to text=False. 2002-08-14 16:37:10 +00:00
Guido van Rossum 830a5151c1 Doc portion of SF 589982 (tempfile.py rewrite, by Zack Weinberg).
Fred, please review!
2002-08-09 16:16:30 +00:00
Guido van Rossum b2865919cc Document that heappop() and heapreplace() raise IndexError if the heap
is empty.
2002-08-07 18:56:08 +00:00
Raymond Hettinger 22c001bd29 Described responsibilty of weakly referenced extension types to initialize
the weakreflist to NULL in the constructor and to fill the tp_flags
slot with Py_TPFLAGS_HAVE_WEAKREFS.  Closes SF bug 586583.
2002-08-07 16:18:54 +00:00
Raymond Hettinger 3cfdc3402e Documented os.fsync and os.fdatasync. Closes SF bug 584695. 2002-08-07 15:48:17 +00:00
Fred Drake 442c7c7743 Clarify that the bool instances are acceptable return values from
__nonzero__(), in response to SF bug #579991.
2002-08-07 15:40:15 +00:00
Fred Drake 95fa4ddf7b Change the markup a bit more; the parameter was not marked as \var in the
sample code, and the note was marked as a logical thing.
2002-08-07 12:39:33 +00:00
Steve Holden 63d5bead18 Fix markup errors. 2002-08-07 12:01:41 +00:00
Fred Drake 2d3c03df9a Added references to the email package.
Closes SF bug #586937.
2002-08-06 21:26:01 +00:00
Guido van Rossum 97c5fccd77 Remove mention of deprecated xreadlines method. 2002-08-06 17:03:25 +00:00
Guido van Rossum 0fc01865f3 Document file.next(). Mark xreadlines obsolete (both method and
module).  (One thing remains to be done: the gzip class has an
xreadline method; this ought to be replaced by an iterator as well.)
2002-08-06 17:01:28 +00:00
Barry Warsaw 817918cc3c Committing patch #591250 which provides "str1 in str2" when str1 is a
string of longer than 1 character.
2002-08-06 16:58:21 +00:00
Steve Holden 545092b063 Add comment about os.path.walk()'s behavior with symbolic links. 2002-08-06 16:07:07 +00:00
Neal Norwitz e72a9a13a1 SF patch #591305 Documentation err in bytecode defs 2002-08-05 23:33:54 +00:00
Raymond Hettinger acb45d72b4 Note that True and False are pickable objects 2002-08-05 03:55:36 +00:00
Steve Holden c8389c91c2 Remove a syntax error in the example, spotted by Walter Hofman. 2002-08-04 15:27:25 +00:00
Tim Peters 0ad679ff0f Document new heapreplace() function. 2002-08-03 18:53:28 +00:00
Tim Peters 6e0da82a97 Document new heapify() function. 2002-08-03 18:02:09 +00:00
Fred Drake 1acab695a7 Minor markup changes. 2002-08-02 19:46:42 +00:00
Guido van Rossum 975121664e Add docs for heapq.py. 2002-08-02 18:03:24 +00:00
Skip Montanaro de994d9130 indicate that 'b' is added to the mode flag if not given 2002-08-02 17:20:46 +00:00
Tim Peters 74824584ef Added new footnote about list.sort() stability. Repaired footnote about
using sort() with comparison functions (it made reference to the non-
existent "builtin-in function sort()").

BTW, I changed list.sort's docstring to contain the word "stable" -- the
easiest way to tell whether a particular Python version's sort *is* stable
is to look for "stable" in the docstring.  I'm not sure whether to
advertise this <wink>.
2002-08-01 03:10:45 +00:00
Fred Drake 5b11bdd0ed SF patch #581414: info reader bug
The "Matching vs. Searching" Info node is unreachable from the Info
program (but is fine in Emacs's Info mode). This patch seems to fix
it.  This is the only occurrence where the info reader fails, so
probably it could be addressed in the python docs as a workaround.
Forwarded the report to the info maintainer.
2002-07-30 17:51:20 +00:00
Martin v. Löwis 0cec0ffc78 Patch #573770: Implement lchown. 2002-07-28 16:33:45 +00:00
Fred Drake db40afaabe Small clarifications when referring to the sys.exc_* variables so that
readers are not given the wrong impression that they should be using those
on a regualar basis.
This closes SF bug #585598.
2002-07-25 21:11:23 +00:00
Jeremy Hylton 403e351dfc Flesh out description of getlogin() and recommend against using it. 2002-07-24 15:32:25 +00:00
Neal Norwitz 1cfcafceb6 add versionadded to doc 2002-07-20 00:46:12 +00:00
Guido van Rossum 18eb8b85b3 Doc patch from SF 474274 (pure Python strptime by Brett Cannon). 2002-07-19 17:09:36 +00:00
Fred Drake f0b095d804 Added documentation for the buffer_text and related attributes of the
xmlparser object provided by pyexpat, new in Python 2.3.
2002-07-17 20:31:52 +00:00
Fred Drake 2095b9690f reduce(): Clarified what is returned in the case of a sequence 1 item long and
initial/default value.
2002-07-17 13:55:33 +00:00
Guido van Rossum 9534e14033 Record the decision that StopIteration is a sink state (see recent
discussion in python-dev with subject "Termination of two-arg iter()").

Implementation will follow.
2002-07-16 19:53:39 +00:00
Guido van Rossum 54ed2d32f9 Clarify that the description of sys.path[0] is only valid upon program
start-up.
2002-07-15 16:08:10 +00:00
Fred Drake 3e59f72075 Clarify the return value of __nonzero__(): It *must* be an integer.
Closes SF bug #579991.
2002-07-12 17:15:10 +00:00
Fred Drake e4523c46b9 Document gc.get_objects().
Closes SF bug #578308.
2002-07-10 19:21:07 +00:00
Fred Drake 4254cbd29c Note that unicode() can raise LookupError for unknown codecs.
Closes SF bug #513666.
2002-07-09 05:25:46 +00:00
Fred Drake c6a525e993 Fix typo reported by Kent Engström, and a bunch of broken markup. 2002-07-08 14:42:22 +00:00
Fred Drake 50e1286c00 Fix typo: "an Unicode string" --> "a Unicode string"
Clarify the return value when the parameter is a Unicode object.
2002-07-08 14:29:05 +00:00
Steve Holden b1af86a1d7 Revise asyncore documentation and document asynchat for the first time. 2002-07-03 18:36:39 +00:00
Fred Drake 228f6e4e7a Fix up a few more consistency nits and incorrectly applied markup.
Further clarify the English-centricity of fix_sentence_endings.
2002-07-03 05:08:48 +00:00
Fred Drake c412617779 Add annotations that describe the change in the "errors" and "failures"
attributes of the TestResult.
2002-07-02 22:46:42 +00:00
Fred Drake 387c8b5f37 Update the documentation of the errors and failures attributes of the
TestResult object.  Add an example of how to get even more information for
apps that can use it.
Closes SF bug #558278.
2002-07-02 22:34:44 +00:00
Greg Ward 285f4a7db7 Don't list all the keyword args to the TextWrapper constructor in the
classdesc -- just use "..." with prose explaining the correspondence
between keyword args and instance attributes.

Document 'width' along with the other instance attributes.

Describe default values consistently.

Typo fixes.
2002-07-02 21:48:12 +00:00
Fred Drake 2c22e85ae7 Attempt to clarify removedirs().
Based on SF bug #574773.
2002-07-02 21:03:49 +00:00
Fred Drake ca23ee273e Deal with & remove the XXX comments.
Change the markup to be more like the rest of the documentation.
2002-07-02 20:37:12 +00:00
Martin v. Löwis 7d650ca83b Implement the encoding argument for toxml and toprettyxml.
Document toprettyxml.
2002-06-30 15:05:00 +00:00
Raymond Hettinger 550fd5d799 Fixed bug 574978 shutil example out of sync with source code 2002-06-30 04:43:20 +00:00
Raymond Hettinger 8a9e8b6d0e Fix bug 575221 referred to dictionary type instead of dict. 2002-06-30 04:32:38 +00:00
Fred Drake 78e057a32a Clarify the version information for the unicode() built-in.
Closes SF bug #575272.
2002-06-29 16:06:47 +00:00
Greg Ward ae64f3adcd Add documentation for new textwrap module. 2002-06-29 02:38:50 +00:00
Fred Drake 2c813818c8 Clean up some markup. 2002-06-27 18:30:34 +00:00
Neal Norwitz dcd0500664 dis.dis() also supports modules 2002-06-26 22:32:47 +00:00
Raymond Hettinger ca0383d3a3 Fix bug #573916. Sender and recipients reversed in email example. 2002-06-26 07:51:32 +00:00
Skip Montanaro 763805dab2 add seealso link to the bisect module 2002-06-26 05:22:08 +00:00