Commit Graph

1614 Commits

Author SHA1 Message Date
Fred Drake 7f577e7fd4 regex and regsub are obsolete and Evil, so don't include them in the club. 2000-09-25 18:26:21 +00:00
Fred Drake e53793bf4c Updates from Fredrik Lundh <effbot@telia.com> about Unicode-related
behavior.
2000-09-25 17:52:40 +00:00
Fred Drake ef5781b8c8 Add obsolescence note to the module descriptions that get added to the
list of module synopses at the front of the chapter; based on a comment
from Aahz <aahz@panix.com>.
2000-09-25 17:23:04 +00:00
Fred Drake d79c33a47b Minor cleanups, wrap long lines. 2000-09-25 14:14:30 +00:00
Fred Drake 7be3115860 Added explanation of the use of the first program argument passed to the
exec*() family of functions.
2000-09-23 05:22:07 +00:00
Fred Drake 7fbc85c5c5 Rename the public interface from "pyexpat" to "xml.parsers.expat". 2000-09-23 04:47:56 +00:00
Fred Drake c32741d1ab Added warnings about platform vagaries to the strptime() documentation.
This closes SourceForge bug #115146.
2000-09-23 04:36:14 +00:00
Neil Schemenauer 544de1effb - Add DEBUG_SAVEALL option. When enabled all garbage objects found by the
collector will be saved in gc.garbage.  This is useful for debugging a
  program that creates reference cycles.

- Fix else statements in gcmodule.c to conform to Python coding standards.
2000-09-22 15:22:38 +00:00
Fred Drake ed773ef78d Include the new text on reporting bugs in a few useful places.
This closes SourceForge bug #114792.
2000-09-21 21:35:22 +00:00
Fred Drake 1bf4e93180 Convert the longest two tables from tableii to longtableii so they do not
make too big a mess.  One actually did not fit on a single page at all!
2000-09-21 16:04:08 +00:00
Fred Drake fffe5dbc47 Fixed a number of small problems reported by Detlef Lannert
<lannert@uni-duesseldorf.de>.
2000-09-21 05:25:30 +00:00
Fred Drake 51f53df4c8 Clarify that the softspace attribute is used by print for state management,
not as a user-controlled parameter.
2000-09-20 04:48:20 +00:00
Fred Drake f5aa4ef07c Add entries for the xml.sax documentation. 2000-09-20 02:54:58 +00:00
Fred Drake e10ef74bb8 First cut at documentation for the xml.sax package (not including any
sub-modules).
2000-09-20 02:52:20 +00:00
Fred Drake 752ba39a0b Clarify a number of issues about the file-like object API based on
discussion on python-dev.
2000-09-19 15:18:51 +00:00
Fred Drake 480abc2751 Document the "printable" and "punctuation" constants added to the string
module.
2000-09-18 16:48:13 +00:00
Fred Drake 1675375a7c Add missing \declaremodule for zipfile. 2000-09-18 16:21:11 +00:00
Tim Peters 1de8098ca6 Repaired some glitches in the MD5 and SHA docs; copied the descriptions of
the MD5 methods into the SHA docs (substituting "sha" for "md5", of course,
and changing the stuff that depended on digest size accordingly).
Fred, don't trust me!
2000-09-18 15:34:57 +00:00
Fred Drake 5316ef4bbb Added documentation for new functions.
Deprecated sequenceIncludes().

Based on patch by Denis S. Otkidach <ods@users.sourceforge.net>,
this closes SourceForge patch #101390.
2000-09-17 16:10:25 +00:00
Fred Drake 6e1fecc28a Update URL to unicode.org's FTP site using an HTTP URL to the same
document.
2000-09-16 13:46:42 +00:00
Fred Drake 315b9e0ac1 Update *both* uses of the URL to the zlib home page, and use the version
advertised as the canonical form.
2000-09-16 06:18:26 +00:00
Fred Drake ab2f9f766f Update link to the zlib homepage. 2000-09-16 05:07:03 +00:00
Fred Drake f29107447a Update the link to Andrew Kuchling's crypto code. 2000-09-16 05:02:24 +00:00
Fred Drake 91fc9319fa Update link to the FIPS PUB 180-1 (PDF is available, but not PostScript). 2000-09-16 04:59:33 +00:00
Tim Peters 78fc0b57df Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
FRED, please check my monkey-see-monkey-do Tex fiddling!
2000-09-16 03:54:24 +00:00
Fred Drake 7c25f3df85 Add some comments on the available implementations that this module can
use.

Change the list of flag values for open() to a table.

Markup consistency nits.
2000-09-15 21:31:31 +00:00
Skip Montanaro 6634b14f3b add cross reference to mimetools module 2000-09-15 18:20:20 +00:00
Fred Drake 6e5184fe6a Update comments in the second paragraph, discussing versioning issues
related to the BSD DB library.  Based on comments from Mark Summerfield
<summer@netcraft.com>.
2000-09-15 15:19:35 +00:00
Fred Drake 81c1735809 Add item to the list of limitations that points out the lack of support
for authenticated proxies.  This is noted elsewhere, but this makes it
easier to find.

Fix typo where it was already mentioned.

This closes SourceForge bug #110619.
2000-09-15 04:12:56 +00:00
Fred Drake 4dfad57235 Add a reference to the sha module, noting that SHA is considered more
secure.  Suggested by Erno Kuusela <erno@iki.fi>.
2000-09-14 21:47:32 +00:00
Fred Drake b9fd468ded Convert "See also" section to use \seetitle. 2000-09-14 21:46:22 +00:00
Fred Drake 6ba0a3c30a Denis S. Otkidach <ods@users.sourceforge.net>:
Minor fix in documentation of code module.
(Clarifies output destination for default implementation of the write()
method.)
2000-09-14 20:42:53 +00:00
Fred Drake 7a666b83c8 Remove reference to the stdwin-based windowed debugger, since stdwin
is gone.

Make a module reference into a hyperlink.
2000-09-14 20:32:17 +00:00
Fred Drake d5d0435617 Use \shortversion in a number of places.
This partially addresses SourceForge bug #114318.
2000-09-14 20:24:17 +00:00
Fred Drake 1fe3b82371 Avoid reference to specific versions of Python where possible.
This partially addresses SourceForge bug #114318.
2000-09-14 18:25:41 +00:00
Fred Drake 66d32b1e12 Add some index entries to make it easier to find information on
%-formatting of strings.
2000-09-14 17:57:42 +00:00
Barry Warsaw ddef8887db Include a link to Francois's po-utils. 2000-09-13 12:04:47 +00:00
Fred Drake ae86d43f11 Add a reference item pointing to the Namespaces in XML recommendation.
Convert the existing reference items to \seetitle markup.
2000-09-12 17:53:48 +00:00
Fred Drake 1349437e4c When referring to namespaces, always say "namespaces" instead of
"name spaces".

Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
Fred Drake 88fa9627b1 Some updates and fix a bunch of really small consistency nits. 2000-09-11 05:23:25 +00:00
Fred Drake 1b194f927d Add a reference to the material on string methods. 2000-09-09 05:34:06 +00:00
Fred Drake f96e0d203b Various clarifications and minor nits fixed. Affected descriptions of
input(), locals(), reload(), unicode(), and zip().
2000-09-09 03:33:42 +00:00
Fred Drake 1172a85175 Really minor consistency nit. 2000-09-09 03:31:17 +00:00
Fred Drake 66571cc20c Improve a couple of references to the language reference, making them
hyperlinks to relevant sections.

Clarify the conditions under which the "softspace" attribute of file-like
objects can "just work" (with relation to overriding of attribute access
in user-defined classes).
2000-09-09 03:30:34 +00:00
Fred Drake 7acb21866c Minor clarifications in the introductory paragraph. 2000-09-09 03:28:00 +00:00
Fred Drake e544191397 Add \modulesynopsis for inclusion in the list of modules at the beginning
of the chapter.

Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
Fred Drake 1c4efad770 Move the "See also" section to a location more consistent with other
module sections.  Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
Fred Drake 621d2bee1c Move description of UserString.MutableString to a location more typical
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
Fred Drake d0726c3cd9 \file is not allowed in section titles -- converting to PDF fails due to
weird macro-expansion issues.  A better solution may be available in the
future, but this will do for now.

Add an index entry.  More should probably be added as well.
2000-09-07 18:55:08 +00:00
Fred Drake 88c023b863 Remove comment about -X and string exceptions. Error noted by
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
Fred Drake 6300bd42a4 Added note about Python version this was added for. 2000-09-07 14:01:40 +00:00
Fred Drake 77a6c9ece5 Minor markup nits around use of \optional. 2000-09-07 14:00:51 +00:00
Fred Drake 8b2e8f846c Added a \versionadded statement to the getfqdn() description. 2000-09-06 02:22:16 +00:00
Fred Drake 8ff4cd7512 Minor markup revisions for consistency with the rest of the documentation. 2000-09-05 13:50:21 +00:00
Fred Drake 0d83f68fc9 Added entry for mmap module. 2000-09-05 13:49:30 +00:00
Barry Warsaw 21fbd540ed Document the new optional argument "rest" on the transfercmd(),
ntransfercmd(), and retrbinary() commands.  This closes SF patch
#101187.
2000-09-01 06:32:32 +00:00
Fred Drake 65faf118b6 Fix markup error and minor consistency nit. 2000-08-31 19:35:56 +00:00
Jeremy Hylton ee5adfbae6 add user-modifiable recursion_limit
ceval.c:
    define recurion_limit (static), default value is 2500
    define Py_GetRecursionLimit and Py_SetRecursionLimit
    raise RuntimeError if limit is exceeded
PC/config.h:
    remove plat-specific definition
sysmodule.c:
    add sys.(get|set)recursionlimit
2000-08-31 19:23:01 +00:00
Fred Drake aef0e890b5 Document the limitation that urllib does not work with proxies which
require authenication.  This is an implementation limitation rather than
required behavior, and may be fixed in the future.

This closes SourceForge bug #111725.
2000-08-31 17:23:35 +00:00
Fred Drake 4c3f797128 UNARY_NEG is supposed to be UNARY_NEGATIVE (spotted by Charles Waldman
<cgw@fnal.gov>).

Fix minor problem with EXTENDED_ARG description markup..
2000-08-31 16:26:35 +00:00
Sjoerd Mullender 1c8feae411 New method getnamespace.
Since the application never gets to see the namespace abbreviation
used in the XML document, but some applications may need to know them,
we provide this method.
2000-08-31 10:27:00 +00:00
Fred Drake fcab76350a Relocate the popen2 documentation since it is now substantially more
portable.
2000-08-31 06:09:26 +00:00
Skip Montanaro 7b828a6a56 doc changes to parallel changes to calendar.py module 2000-08-30 14:02:25 +00:00
Fred Drake d576e9df5f Markup revisions. Nothing was actually required to be able to format it,
but many conventions were broken.
2000-08-30 04:19:20 +00:00
Barry Warsaw 28b815f28a Oops, spell MAL's name right. 2000-08-30 03:28:17 +00:00
Barry Warsaw 0691a6b8ed Documentation for the gettext module. 2000-08-30 03:27:10 +00:00
Barry Warsaw 058365aec5 Added libgettext.tex 2000-08-30 03:26:17 +00:00
Moshe Zadka a1a4b5916b Closing patch #101120 -- After everyone agreed. 2000-08-25 21:47:56 +00:00
Fred Drake 0308ff8652 Add reference to RFC 2396 in "See also" section.
Minor cleanups.
2000-08-25 17:29:35 +00:00
Fred Drake dfca4dc503 Revised documentation relevant to SourceForge patch #100837
(simplify making HTTP POST requests).

Added documentation of URLopener.version and how it can be overridden.
2000-08-25 05:13:42 +00:00
Andrew M. Kuchling 99a3701618 Documentation for poll() interface (SF patch #100852) 2000-08-25 01:21:28 +00:00
Thomas Wouters 12bba852a9 Rough and incomplete documentation on augmented assignment, which follows
shortly. Markup also needs checking.
2000-08-24 20:06:04 +00:00
Guido van Rossum 3d0c77b37c Addresses the other half of Bug #112634 -- the documentation suggested
that you can set self.version *after* calling the base class __init__.
In fact it must be done *before*.

(Fred, maybe the version class variable should be documented now?)
2000-08-24 16:20:32 +00:00
Fred Drake 45ca3331d9 Move references to RFCs to a "See also" section for consistency with
other sections of the library reference.
2000-08-24 04:58:25 +00:00
Fred Drake 9fa4d61bcc Moshe Zadka <moshez@math.huji.ac.il>:
Documentation updates for urlretrieve() and URLopener.retrieve(), to
reflect Randall Hopper's patch for those functions.

This closes SourceForge patch #100837.
2000-08-24 01:06:40 +00:00
Fred Drake 093272ea85 Charles G. Waldman <cgw@fnal.gov>:
Update the dis module documentation to reflect the EXTENDED_ARG opcode.
2000-08-24 00:37:50 +00:00
Skip Montanaro 297bf7ceb5 update commonprefix doc to make sure user is aware it works
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
2000-08-23 16:58:32 +00:00
Barry Warsaw 9087688581 Describe the new PRINT_ITEM_TO and PRINT_NEWLINE_TO opcodes. 2000-08-21 17:19:00 +00:00
Andrew M. Kuchling 120beb6b67 Strengthen the warning against using SerialCookie and SmartCookie.
(If they're security holes, should they be documented at all?)
Minor rewrites.
2000-08-20 23:33:50 +00:00
Fred Drake 15446d344d Add entry for Cookie module. 2000-08-19 16:55:31 +00:00
Fred Drake e5c7352201 Make it format.
Adjust markup for hyperlinking to the relevant RFCs.
Give it a little organization.
Minor nits.
2000-08-19 16:54:57 +00:00
Moshe Zadka 1b07f2bcf6 Initial revision. Markup unchecked. 2000-08-19 14:11:41 +00:00
Fred Drake 512bb72fb0 As pointed out by Denis S. Otkidach <den@analyt.chem.msu.ru>, xrange()
returns an xrange object, not a range object, despite the name of the
source file they're implemented in.

In the list of comparison operators, list != before <>, since <> is
described as obsolescent.
2000-08-18 03:12:38 +00:00
Fred Drake 304faf944c Fix a markup error that caused formatting to fail.
Lots of minor markup adjustments as well.
2000-08-18 02:15:55 +00:00
Andrew M. Kuchling 0690c86a2a Document the returns_unicode attribute 2000-08-17 23:15:21 +00:00
Thomas Wouters 5215225ea1 Apply SF patch #101135, adding 'import module as m' and 'from module import
name as n'. By doing some twists and turns, "as" is not a reserved word.

There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
Fred Drake dd611b0070 A little more text, and some really minor cleanups. 2000-08-17 22:31:23 +00:00
Fred Drake e581bb30c4 Small cleanups, and note when zip() entered the menagerie. 2000-08-17 22:30:30 +00:00
Fred Drake b32aa5ecef Revise the comments about the exceptions module to not refer to source
code; it is not sufficiently readable now that it in written in C, and
is less likely to be available to end users.
2000-08-17 22:29:31 +00:00
Fred Drake 25699f99f4 Martin v. Loewis <martin@loewis.home.cs.tu-berlin.de>:
Document opcodes added to support extended call syntax.
2000-08-17 22:19:26 +00:00
Fred Drake 5772c86816 Document socket.getfqdn(). 2000-08-16 14:21:42 +00:00
Thomas Wouters caa658d047 Apply SF patch #101151, by Peter S-K, which fixes smtplib's passing of the
'helo' and 'ehlo' message, and exports the 'make_fqdn' function. This
function should be moved to socket.py, if that module ever gets a Python
wrapper.
2000-08-15 19:30:36 +00:00
Fred Drake d066f6d780 Fix markup bug that prevented formatting.
Adjusted some markup for consistency with the rest of the documentation
and creation of the proper index entries.
2000-08-15 17:47:09 +00:00
Barry Warsaw 0be4346da6 Describe the b2a_hex() and a2b_hex() functions (a.k.a. hexlify() and
unhexlify() respectively).
2000-08-15 06:08:00 +00:00
Barry Warsaw 4ef4be53ac Added description of the md5.hexdigest() method. 2000-08-15 06:00:28 +00:00
Fred Drake a2b6ad6e27 Guido pointed out that all names in the sys module have no underscore, 2000-08-15 04:24:43 +00:00
Fred Drake 68e2915fc7 Document the byte_order value in the sys module. 2000-08-14 15:47:30 +00:00
Fred Drake 107b9679c4 Document the range type, as suggested by Denis S. Otkidach
<den@analyt.chem.msu.ru>.
2000-08-14 15:37:59 +00:00
Fred Drake 4de96c2fd8 Added Marc-Andre Lemburg's documentation for string methods, with some
massaging for markup consistency.  This closes SourceForge patch #101063.

Added Unicode strings and buffer objects to the list of sequence types.

Small markup nits elsewhere.
2000-08-12 03:36:23 +00:00
Thomas Wouters 0be5aab04d Merge UNPACK_LIST and UNPACK_TUPLE into a single UNPACK_SEQUENCE, since they
did the same anyway.

I'm not sure what to do with Tools/compiler/compiler/* -- that isn't part of
distutils, is it ? Should it try to be compatible with old bytecode version ?
2000-08-11 22:15:52 +00:00