Commit Graph

1771 Commits

Author SHA1 Message Date
Fred Drake 8d3312f4d1 Add documentation and warnings for the isCallable(), isMappingType(),
isNumberType(), and isSequenceType() functions.

This closes SourceForge bug #115789.
2000-10-02 03:36:18 +00:00
Martin v. Löwis d15a9427e8 Fixed spelling of module; closes bug 115712. 2000-09-30 17:04:40 +00:00
Fred Drake 58295dedf7 Replace to XXX notes to add references with real references. 2000-09-30 00:11:45 +00:00
Fred Drake 4ce4f2eedd os.startfile() documentation, based on text from Tim Peters. 2000-09-29 04:15:19 +00:00
Fred Drake 8a9db99760 Updated documentation relating to the various flavors of popen[234]()
for Windows & Unix.
2000-09-28 20:27:51 +00:00
Fred Drake 44774c9429 Add regex and regsub to the list of undocumented obsolete modules. 2000-09-28 05:31:39 +00:00
Fred Drake 33dde92ecf Update the documentation for ConfigParser to match the recent changes. 2000-09-27 22:48:44 +00:00
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
Fred Drake 46479d3740 Some minor clarifications and added some index entries. 2000-08-11 20:34:27 +00:00
Fred Drake 3ac977e39c O_BINARY: Documented this constant; omission noted by David Ascher.
access():  Corrected availability statement; error pointed out by
           Tim Peters.
2000-08-11 20:19:51 +00:00
Fred Drake a8e484c8f5 getopt(): revise description of long_options parameter slightly so it will
be less confusing; add a paragraph separation so that comments about
	the options and long_options parameters don't have references that
	are easily misinterpreted.

Adjust the interactive examples to not need the string module.

Add an example showing how the module is commonly used in a script.
2000-08-11 19:55:06 +00:00
Peter Schneider-Kamp 10e1bf2f64 remove all occurence of math.rint() from the sources
(and yes, "Currintly" also counts <0.5 wink>)
2000-08-10 04:23:30 +00:00
Eric S. Raymond 65983372f0 More on noutrefresh. 2000-08-09 21:49:31 +00:00
Eric S. Raymond 1ebd3f6c4b Tweak curses.wrapper so it initializes colors if they are available. 2000-08-09 21:11:07 +00:00
Fred Drake 3fe9a98c95 Correct markup error. 2000-08-09 14:37:05 +00:00
Fred Drake fc1f9229f4 Correct version number at which the curses.ascii module was introduced. 2000-08-09 14:36:11 +00:00
Fred Drake ec4b2af6bb Fix a few markup errors and lots of small consistency issues.
Add "See also" link to curses.wrapper module from curses module.
2000-08-09 14:34:48 +00:00
Guido van Rossum 8141cf5c76 Barry's patch to document the new setdefault() method. Slightly
clarified the summary for default() in the table to indicate the side
effect.
2000-08-08 16:15:49 +00:00
Vladimir Marangozov f9d20c3786 Neil Schemenauer: GC enable(), disable(), isenabled() interface.
Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>
2000-08-06 22:45:31 +00:00
Eric S. Raymond 5a007693c1 Documented curses.wrapper and curses.textpad. 2000-08-04 07:35:41 +00:00
Fred Drake ed13b4a5a6 Break the "Python Services" chapter into two: "Python Runtime Services"
(still at the start of the manual), and "Python Language Services" (late
in the manual).  Moved "Restricted Execution" to just before "Python
Language Services."
2000-08-03 21:18:18 +00:00
Fred Drake 8b168ba505 int() description: Fix markup to avoid image generation for math mode.
zip() description:  Fix broken markup, three small markup consistency nits,
	and one really minor usage nit.  Introduce use of \moreargs instead
	of hardcoding "..." with \optional.
2000-08-03 17:29:13 +00:00
Barry Warsaw faefa2a885 Both PEP 201 Lockstep Iteration and SF patch #101030 have been
accepted by the BDFL.

Added documentation for zip() builtin.
2000-08-03 15:46:17 +00:00
Fred Drake 6c7a46a2f0 Rob Hooft <rob@hooft.net>:
Description of fcntl():  Added description of what can go wrong.
2000-08-02 20:53:51 +00:00
Mark Hammond 21a4764b9a As requested by Fred - mention that in the future a winreg module may make a comeback. 2000-08-01 23:49:50 +00:00
Peter Schneider-Kamp f917bf6080 fixing a minor spelling mistake 2000-08-01 00:07:17 +00:00
Fred Drake fbd3b45bb7 Stop lying about [].pop() being experimental! There is no backing it out
at this point.
2000-07-31 23:42:23 +00:00
Peter Schneider-Kamp 5a65c2d436 added count, extend, index, pop and remove to arraymodule 2000-07-31 20:52:21 +00:00
Fred Drake 1e75e1776f Two minor nits from Gerry Weiner (no working email address) about
describing the methods of dictionaries.
2000-07-31 16:34:46 +00:00
Fred Drake 578a3f9638 Moshe Zadka <mzadka@geocities.com>:
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
2000-07-31 15:45:46 +00:00
Fred Drake 10853c9835 Finally fixed the much-reported bug about "~" in a couple of example.
This time, it was reported by Skip.
2000-07-28 13:51:27 +00:00
Eric S. Raymond b924bd4610 Second round of curses documentation improvements. Completes and extends
documentation for function keys, special characters.
2000-07-27 21:10:02 +00:00
Andrew M. Kuchling 1962fb59f3 Document tiget{flag,num,str} 2000-07-26 02:59:13 +00:00
Fred Drake e1b304db37 Fix small typos and markup consistency nits. 2000-07-24 19:35:52 +00:00
Eric S. Raymond 6899660a81 First round of curses documentation improvements; correct errors, flesh out
entry point descriptions.
2000-07-24 03:28:40 +00:00
Skip Montanaro d372521ec0 added doc for isatty() 2000-07-19 17:30:58 +00:00
Skip Montanaro 7cb1524586 added documentation for new functions {get,set}_history_length 2000-07-19 16:56:26 +00:00
Thomas Wouters f8316638af Rob W. W. Hooft's spelling fixes for the Library Reference. I hope
SourceForge doesn't choke on this batch :-)

I'm not entirely sure this is 100% correct. The patch changes an
\index{persistency} to \index{presistence}, and I don't know what \index{}
does. But it seems to do so persi--er, consistently, so I hope it isn't a
problem.
2000-07-16 19:01:10 +00:00
Eric S. Raymond f868de6491 Document the second round of ConfigParser changes. 2000-07-14 15:00:02 +00:00
Andrew M. Kuchling 8d2f2b2db2 From Sam Rushing's Medusa, via SF patch #100858: add & document
os.seteuid(), os.setegid(), os.setreuid(), os.setregid().
2000-07-13 01:26:58 +00:00
Fred Drake bdcf91fda0 Documentation for the gc module. Text from Neil Schemenauer
<nascheme@enme.ucalgary.ca>, markup & minor revisions from Fred
Drake.
2000-07-12 04:22:53 +00:00
Eric S. Raymond 7ae3a5e79d Resynchronize the TeX docs with (a) the module docstring, and (b) my recent
fix to the code to make it behave like the module docstring.
2000-07-12 02:56:15 +00:00
Fred Drake acab3d61e9 Change the table in the pyexpat.errors module to a series of datadesc
elements (since the table was pretty screwed up); this is how it is done
elsewhere in the manual.

I could use some help creating descriptions of the specific error
identifiers (input conditions that lead to each error, etc.).
2000-07-11 16:30:30 +00:00
Eric S. Raymond 417c489def Give ConfigParser the capability to set as well as read options, and to write
a representation of the configuration state in .ini format that can be read
back in by a future read() call.  Thus this class is now a back end
for .ini editors as well as parsers.

This patch is complete and tested, but exposes a bug in the ConfigParser
implementation which I have not yet fixed.  Because case information is
discarded during parsing, the output of write() has its case smashed.

I wrote this for a SourceForge interface script called forgetool.
Documentation for the new entry points included.
2000-07-10 18:11:00 +00:00
Fred Drake 146b28086f Minor revisions similar to some information in the new docstrings. 2000-07-08 16:59:03 +00:00
Fred Drake c826ecbf8f Add an entry for the KDE File Manager support from Peter Funk. 2000-07-07 17:08:40 +00:00
Fred Drake e4dbb86ab8 New module webbrowser. Easy-to-use controller objects to make using a
Web browser as a help/information browser easy across platforms.
2000-07-07 03:36:12 +00:00
Fred Drake aa7524cf1f Clean up markup to be more like recommended practice; only small changes
needed.
2000-07-06 18:37:08 +00:00
Fred Drake 29fa30ea6b Correct a markup nit that caused a space to be dropped from the HTML
version (actually a LaTeX2HTML bug), and clarified a sentence in the
mktime() description based entirely on comments from Grant Griffin
<grant.griffin@honeywell.com>.
2000-07-06 18:09:02 +00:00
Fred Drake 3c62d9e656 Several small changes, mostly to the markup, to improve consistency and
internal hyperlinking.  Move some things around, also for consistency
with other modules ("See also" stuff tends to live at the \section level,
before sub-sections, etc.).
2000-07-06 04:51:04 +00:00
Fred Drake 14ea85f325 Add entry for readline documentation. 2000-07-06 04:47:25 +00:00
Fred Drake 011028cf74 Sjoerd Mullender <sjoerd@oratrix.nl>:
Updates for recent changes in xmllib.
2000-07-06 04:45:14 +00:00
Fred Drake d14423abe2 Correct typo in description of the machine name parameter to the
ConnectRegistry() function; there is no trailing period!
2000-07-06 04:38:37 +00:00
Skip Montanaro 63099f911f added seealso pointing reader at readline example which uses atexit. 2000-07-06 03:26:39 +00:00
Skip Montanaro 510ca1d338 simple-minded readline section doc based upon module's doc strings. 2000-07-06 03:25:26 +00:00
Skip Montanaro 0915165096 added warning about incompatibility with other codes' use of sys.exitfunc. 2000-07-05 23:11:26 +00:00
Fred Drake b5316188ee Created a new chapter on structured markup processing, including the
existing SGML, HTML, & XML support, and providing a home for the new
XML support as it becomes documented.
2000-07-05 02:24:39 +00:00
Fred Drake c05cbb0527 Wrapped some long lines.
Cleaned up the table of error constants defined in pyexpat.errors; an
extra pair of braces had pretty much destroyed the table!  (Not sure why.)
Moved the pyexpat.errors module documentation into a \section with the
proper headers for a module.
2000-07-05 02:03:34 +00:00
Fred Drake 25e7cee1c8 get_starttag_text(): Document this method. 2000-07-03 14:32:04 +00:00
Fred Drake 52dc76c81f Eric S. Raymond <esr@thyrsus.com>:
This patch implements relative-path semantics for the "source" facility resembling
those of cpp(1), documents the change, and improves the shlex test main to
make it easier to test this feature.  Along the way, it fixes a name error
in the existing docs.

[Additional documentation markup changes for consistency by FLD.]
2000-07-03 09:56:23 +00:00
Fred Drake 353aaadd9b Moshe Zadka <moshez@math.huji.ac.il>:
Substantial updates to reflect Moshe's Gordon's enhancements to the
module.

Additional changes from Fred to reflect his changes to the module as well.
2000-07-03 08:24:49 +00:00
Fred Drake fcc95a4d04 Tim-blessed documentation for math.frexp(). 2000-07-03 06:38:17 +00:00
Fred Drake c3a65982a3 others --> other's (possessive)
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:47:38 +00:00
Fred Drake 506a7a87ff Send a "ARTICLE" --> Send an "ARTICLE"
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:43:19 +00:00
Fred Drake 30f76ffd00 Update version numbering from 1.6 to 2.0. 2000-06-30 16:06:19 +00:00
Fred Drake f0e88980f3 Document randrange(). 2000-06-30 15:32:31 +00:00
Fred Drake 57a2f7f8ef Change description of altzone to not refer to the "0th meridian". 2000-06-30 04:24:52 +00:00
Fred Drake 9a748aa832 Say "manual page", not "man page", when referring to the Unix manual. 2000-06-30 04:21:41 +00:00
Fred Drake abbc7344a4 Make sure to note that this module was added for Python 2.0! 2000-06-30 03:50:06 +00:00
Fred Drake 6e71cdd9f1 Reflect the name change to _winreg; we still need documentation for the
new winreg module.
2000-06-30 03:45:40 +00:00
Andrew M. Kuchling efc43d4478 Document recently-added mouse-related functions 2000-06-30 01:05:39 +00:00
Fred Drake 8aa3bd9098 Make it clear that id() can return either a long integer or a plain integer. 2000-06-29 03:46:46 +00:00
Fred Drake 5c529d3f3e Add a "See also:" link to the curses.ascii module. 2000-06-28 22:11:40 +00:00
Fred Drake 589f44b9d0 Made the title of the Examples subsection plural! 2000-06-28 22:09:20 +00:00
Fred Drake be93a8332e Added note that the atexit module was added for Python 1.6. 2000-06-28 22:07:55 +00:00
Fred Drake 6f2a5efec9 Added entry for the curses.ascii module. 2000-06-28 22:05:44 +00:00
Fred Drake 5ccd4b2a54 Added entries for the curses.ascii module. 2000-06-28 22:03:29 +00:00
Fred Drake 4e716fa0ac Skip Montanaro <skip@mojam.com>:
Added an example of using an HTTP POST request.
2000-06-28 21:51:43 +00:00
Fred Drake c82634c13c Thomas Wouters <thomas@xs4all.net>:
Documentation updates related to the addition of openpty() and forkpty().
2000-06-28 17:27:48 +00:00
Fred Drake c19425d520 Added the atexit module and documentation from Skip Montanaro
<skip@mojam.com>.  Revisions to the markup to make it pass LaTeX, added
an index entry and a reference from the sys.exitfunc documentation.

This closes SourceForge patch #100620.
2000-06-28 15:07:31 +00:00
Andrew M. Kuchling af5b76677f Changed obsolete e-mail alias 2000-06-27 03:16:04 +00:00
Andrew M. Kuchling f57d7b9e30 Dcoumentation for ascii.py. I've changed two references from ascii to
curses.ascii.
2000-06-26 23:59:24 +00:00
Andrew M. Kuchling a4ca07cc8c Minor grammatical fix 2000-06-21 01:48:46 +00:00
Andrew M. Kuchling d24ff44f06 Document .timeout() method and .typeahead() function 2000-06-21 01:42:51 +00:00
Andrew M. Kuchling 0adfb45b9a Make changes and clarifications suggested by Mark Hammond 2000-06-18 04:17:38 +00:00
Andrew M. Kuchling b8050697b8 Documentation for the mmap module: proofreaders welcomed 2000-06-17 22:39:05 +00:00
Fred Drake 9e759dfc31 Michael Hudson <mwh21@cam.ac.uk>:
This patch corrects a little glitch and two outright errors.

(Including one reported earlier by Thomas Wouters.)
2000-06-15 18:44:30 +00:00
Fred Drake fb79ffae4d Hook in the documentation for the unicodedata module. 2000-06-13 20:51:29 +00:00
Fred Drake 28b294459d Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for the unicodedata module (massaged by Fred for minor
consistency issues).
2000-06-13 20:50:50 +00:00
Andrew M. Kuchling 6b14eebae6 Documentation for the pyexpat module. 2000-06-11 02:42:07 +00:00
Fred Drake d1a65ff40b Added preliminary documentation for the winreg module,
by Mark Hammond <markh@activestate.com>.

Limited markup & consistency revisions by FLD.
2000-06-07 04:07:48 +00:00
Fred Drake 6c16019136 Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code. 2000-05-30 14:39:45 +00:00
Fred Drake b80a777859 Added documentation for gettempprefix().
Deprecated direct access to template.
Added note about past need to modify template so that legacy code has a
better chance of being understood, noting that the requirement to reset
template after os.fork() disappeared in 1.5.2.
2000-05-26 19:32:14 +00:00
Fred Drake 0233075fce Added documentation for TemporaryFile() and the siffix parameter to mktemp().
Removed obsolete comments about this module not creating or removing actual
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().
2000-05-26 19:05:16 +00:00
Fred Drake 99d707af47 Piers Lauder <piers@cs.su.oz.au>:
I've added an extra comment about quoting arguments to
IMAP4 commands. Also changed the command descriptions
to show optional extra commands where appropriate.

Fred Drake:
Added example usage for the search() method based on comments from
<Lucas.DeJonge@awtpl.com.au>; elaborated error handling information
when arguments are missing from search() and uid().
2000-05-26 04:08:37 +00:00
Andrew M. Kuchling f1dc5fa2c8 Updated docs to list all the new methods and functions. The docs are
now complete, but probably still not very helpful or friendly.

Note: two very large tables (of key names, and of character names) were
added; these tables format terribly, and need some reworking.
2000-05-23 16:46:04 +00:00
Fred Drake 7cb42cd070 From Greg Ward <gward@python.net>:
Typo:  "dictionairy" --> "dictionary" (twice).
2000-05-23 02:28:26 +00:00
Fred Drake 8c5cedee69 New description for math.frexp() -- poor description noted by
Francois Pinard.
2000-05-18 05:07:38 +00:00
Guido van Rossum c9a5f343bc The addition of rint() (by Peter Schneider-Kamp; I forgot to mention
that before) in the previous patch has one problem; rint() is not in
the C math library on all platforms (e.g. not for VC++).  Make it
conditional on HAVE_RINT.
2000-05-11 18:42:27 +00:00
Guido van Rossum 71260b846e Added math.rint() -- round according to current IEEE754 mode 2000-05-11 18:19:42 +00:00
Fred Drake 625d70a7a6 Fix references to the built-in compile() that don't include the
filename parameter.  Noted by Randall Hopper <aa8vb@yahoo.com>.
2000-05-09 17:10:23 +00:00
Fred Drake 35784dff6a Skip Montanaro <skip@mojam.com>:
The intent is that this diff adds a link to the rfc822 module doc and
an index reference to this module under the rfc822 heading.

Fred, based on a suggestion from Grant Griffin <grant.griffin@honeywell.com>:
Added link to the MIME FAQ, so people can more easily get more
information about the subject of the module.
2000-05-09 16:23:23 +00:00
Fred Drake d85f05940e read() method: clarify that strings are accepted and interpreted
reasonably.

readfp() method:  added documentation.
2000-05-09 15:06:32 +00:00
Fred Drake 3d69c0e440 Someone found the examples of poor practice on socket addresses!
Spotted by Greg Kochanski <gpk@bell-labs.com>.
2000-05-03 19:40:32 +00:00
Fred Drake ae08853fb0 Clarify status of connection of a new instance; it *is* connected if
you pass server information to the constructor.  Error noted by Pedro
Diaz Jimenez <diazjimenez@ctv.es>.
2000-05-03 15:11:47 +00:00
Fred Drake e06d025e00 Use \versionchanged to indicate when the second parameter to utime()
was allowed to be None.
2000-05-02 17:29:35 +00:00
Guido van Rossum d67ddbbec1 Eric Raymond:
(1) Added and documented the capability for shlex to handle
lexical-level inclusion and a stack of input sources.  Also, the input
stream member is now documented, and the constructor takes an optional
source-filename.  The class provides facilities to generate error
messages that track file and line number.

(2) Add a convenience function to generate C-compiler style error
leaders.
2000-05-01 20:14:47 +00:00
Barry Warsaw 93a8eacde5 Document the new additional signature for utime(). In addition to the
previous functionality utime(path, (atime, mtime)), now allowed is
utime(path, None) which sets the file's times to the current time.
2000-05-01 16:18:22 +00:00
Fred Drake 40ee7acb95 \file and \filenq should not be used in section titles; they are not
sufficiently robust to survive the creation of bookmarks in the PDF
format.
2000-04-28 18:17:23 +00:00
Fred Drake ac308d0a6f Added a "See also:" section that exhibits the \seerfc markup. 2000-04-26 18:20:04 +00:00
Fred Drake cebda6f5f0 Added documentation for WindowsError; omission noted by Michal Bozon
<bozon@natur.cuni.cz>.

(Mark Hammond, other Python/Windows cognoscenti: please check this!)
2000-04-17 17:42:00 +00:00
Fred Drake 9cf7587fdc Update change to version_info structure. 2000-04-13 17:51:58 +00:00
Fred Drake 4d65d73686 Document hexversion (incompletely explained) and version_info (easily
explained).
2000-04-13 16:54:17 +00:00
Fred Drake ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +00:00
Fred Drake 0682be4524 letters:
Fix description; lowercase and uppercase are strings, not
        functions!  Noted by Randall Hopper <aa8vb@yahoo.com>.

maketrans():
        Minor markup nits in description.
2000-04-10 18:35:49 +00:00
Fred Drake 9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +00:00
Fred Drake 69ca950d1f Make sure the \declaremodule uses the right name for the module!
Clean up several markup problems & inconsistencies.
2000-04-06 16:09:59 +00:00
Fred Drake 343301aaa4 unichr(),
unicode():  Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
Fred Drake 0b72116812 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeType.
2000-04-06 15:05:04 +00:00
Fred Drake 56ced2a7e4 Marc-Andre Lemburg <mal@lemburg.com>:
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
Fred Drake 5828ad6963 Revised / removed comments about string exceptions (relating to the
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
Fred Drake 3cb793e8e8 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
Fred Drake 61098f201e Marc-Andre Lemburg <mal@lemburg.com>:
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
Fred Drake 665dd704a3 Note the exception raised when parameter to chr() is out of range. 2000-04-06 14:45:19 +00:00
Fred Drake 33d51841a3 Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
Fred Drake 98f8a3d8da Added codecs entry here as part of String Services. 2000-04-06 14:25:28 +00:00
Fred Drake b7979c756c Marc-Andre Lemburg <mal@lemburg.com>:
codecs module documentation, with some preliminary markup
adjustments from FLD.
2000-04-06 14:21:58 +00:00
Fred Drake 6d5c6bdb25 Removed bogus connect() call in SMTP example; reported by Travis
B. Hartwell <slt5v@cc.usu.edu>.

Removed second copy of the "See also" section!
2000-04-05 22:12:06 +00:00
Fred Drake 71b04dab58 Added reference to the multifile module from the "See also" section
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
2000-04-05 22:05:15 +00:00
Fred Drake d1a56f4235 Noted by Guido:
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist.  Reference is now to UTC.
2000-04-05 15:06:03 +00:00
Fred Drake 898915d7e2 Noted by Guido:
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
Fred Drake 43b89b637f Noted by Guido:
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
2000-04-05 15:00:38 +00:00
Fred Drake 12ed36525a Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
(re-written).
2000-04-04 20:43:50 +00:00
Fred Drake 005f494a7f Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>. 2000-04-04 20:42:38 +00:00
Fred Drake 7d68690d8d Added notes about the eventual disappearance of two-parameter bind(),
connect(), and connect_ex().

I didn't make these deprecation notices since it was never a
documented feature.
2000-04-04 17:48:30 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake 6a0d844e76 UserString section:
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.

Make the spelling of Unicode always uppercase.
2000-04-03 15:02:35 +00:00
Fred Drake a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake 3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +00:00
Fred Drake 15861b2a41 Update portability information for the spawn*() functions and related
constants.  Someone will need to fill in information on the spawn*()
functions that aren't listed.
2000-02-29 05:19:38 +00:00
Fred Drake 0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +00:00
Fred Drake 155348be33 Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor
consistency changes and a note that the API may change in the future.
2000-02-23 15:44:08 +00:00
Fred Drake 1e862e8a37 Update the description of int() to include the radix parameter;
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
2000-02-17 17:45:52 +00:00
Guido van Rossum 8006d316bc Added docs for new crc32() function. By Jim Ahlstrom.
(Fred, please check.)
2000-02-16 21:13:37 +00:00
Barry Warsaw 41d84631ba Document the API changes to the nntplib module (exceptions become
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
2000-02-10 20:26:45 +00:00
Fred Drake 2bb43a20ce The dircmp module is now obsolete. 2000-02-03 15:27:26 +00:00
Fred Drake 76e6da38c0 Document GetoptError and label error an alias. 1999-12-21 22:50:05 +00:00
Fred Drake b9bdfc6a23 Document 1.5.2+ aspects of the NotANumber exception. (Note that this
is in the development branch, not the maintenance branch!)
1999-12-21 18:45:16 +00:00
Fred Drake 89ab163479 Document that the |mode| parameter to open() is optional and explain how
the default value is determined.
1999-12-21 18:31:30 +00:00
Fred Drake 88f6ca2ce9 Document getgroups(), getlogin(), fpathconf(), pathconf(),
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00