Commit Graph

3712 Commits

Author SHA1 Message Date
Guido van Rossum 97d3b93c2f Document changed default to passive mode. 2001-01-15 16:37:05 +00:00
Guido van Rossum 77b20f099e Document filterwarnings(..., append=<bool>). 2001-01-14 14:10:18 +00:00
Fred Drake 34bafcc079 Fix a variety of minor nits and typos caught by Chris Ryland
<cpr@emsoftware.com>.
2001-01-14 02:57:14 +00:00
Fred Drake 1beb3d204f Added note that this module was added in Python 2.1. 2001-01-12 22:57:32 +00:00
Fred Drake ca7e1ee01a Updated descriptions to incorporate additional information from Tim Peters.
This mostly closes SF bug #128251.
2001-01-11 22:49:49 +00:00
Martin v. Löwis a177c40daf Document \code{import} in pth files. 2001-01-11 22:07:25 +00:00
Fred Drake 49c9ac30a4 Fixed minor markup nits for consistency with the rest of the library
reference.
2001-01-11 16:02:08 +00:00
Eric S. Raymond ab78beca2f Added pointer on POP3 variations. 2001-01-11 10:22:34 +00:00
Moshe Zadka f68f2fec7d Implementation of PEP-0217.
This closes the PEP, and patch 103170
2001-01-11 05:41:27 +00:00
Eric S. Raymond 5ac97957f7 Corrections and additions to the documentation for POP3 and IMAP library
support, based on my fetchmail experience.
2001-01-11 04:19:52 +00:00
Eric S. Raymond 8321026ff4 SourceForge patch #103140, checked in at fdrake's invitation. Minor fixes and
additions to library docs.#
2001-01-10 19:34:52 +00:00
Fred Drake fe338ca540 Fix a typo, remove one copy of a duplicated name. 2001-01-10 05:33:38 +00:00
Fred Drake 675e1d0a0d Remove bogus "echo" command. 2001-01-09 22:50:13 +00:00
Fred Drake 3c48ef7de8 Added documentation for the xreadlines module & related changes. The
documentation was written by Jeff Epler (thanks!).
2001-01-09 22:47:46 +00:00
Fred Drake 42181dba8e Added a --global-module-index option to specify a (possibly relative) URL
to the Global Module Index for a set of documents.  This is used to include
a reference to the global index from the per-document module indexes, so
that it is just a little easier to find.

(Someone suggested this, but I do not remember who.  Please let me know if
it was you -- thanks!)
2001-01-09 22:02:10 +00:00
Fred Drake c49480ed51 Miscellaneous updates. 2001-01-09 21:40:52 +00:00
Fred Drake 347a62505c Steve Holden <sholden@holdenweb.com>:
Clarify the handling of characters following backslashes in raw strings.
2001-01-09 21:38:16 +00:00
Fred Drake d5f0198dec Added names. 2001-01-09 20:55:09 +00:00
Fred Drake 986eafdc2b Added missing word; fixed minor nits. 2001-01-09 20:54:15 +00:00
Fred Drake 37f1b34b62 Added entry for fpectl module documentation.
Moved the mutex docs to be adjacent to the sched docs, since these are
meant to be used together (if they are used at all!).
2001-01-09 20:52:49 +00:00
Fred Drake fa214cca61 Added entry for fpectl module documentation. 2001-01-09 20:50:02 +00:00
Fred Drake a5e7ad99d5 Documentation for the fpectl module, from Lee Busby. (Thanks!) 2001-01-09 20:38:54 +00:00
Fred Drake 45b1d6a831 Explain that long options are matched based on a unique prefix rather than
requiring the whole option to be typed out.

This closes SF bug #126863.
2001-01-08 16:05:51 +00:00
Fred Drake 81473b12b7 The Python/C API deals in PyObject*, not PyDictObject*. 2001-01-08 05:53:53 +00:00
Fred Drake e1d4715a6f Update explanation of the set_location() method to indicate that in
BTree databases, the key need not be in the database.  Also, tell about
the exception if the key is not in the DB for other DB types.

This closes SF bug #127377.
2001-01-05 06:44:19 +00:00
Fred Drake b31d36cf01 Fix the bugfix for SF bug #127151 -- make sure we map "previous_page" to
"previous" and "next_page" to "next".  This way the proper icons are found.
2001-01-04 15:16:01 +00:00
Fred Drake 445f832060 __rcmp__() description: Changed to indicate that this is no longer
supported as of Python 2.1.  We still need to
                         have an entry for this since it is reasonable
                         for users to want to understand existing code.

This closes SF bug #122715.
2001-01-04 15:11:48 +00:00
Fred Drake 4e18f07613 Based on comments from Guido, do not describe bisect() and insert() as
being "for backward compatibility."  Also revert to using bisect() in the
example, since Guido thinks that is the best recommendation for typical
usage.
2001-01-04 14:18:55 +00:00
Fred Drake 288927f426 Markup nit: Command line options should be marked with \programopt.
Other minor markup nits fixed.

Make reference to PyErr_Warn() a hyperlink.
2001-01-04 05:59:37 +00:00
Fred Drake 316ef7c574 Markup nit: Command line options should be marked with \programopt. 2001-01-04 05:56:34 +00:00
Fred Drake b162d188f6 Fix typo spotted by Detlef Lannert <lannert@users.sourceforge.net>. 2001-01-04 05:48:08 +00:00
Fred Drake 19ae78302e Added information about the interaction of opening a file in append mode
and seek() in the description of seek().

This closes SF bug #126850.
2001-01-04 05:16:39 +00:00
Fred Drake 22e9a5eaec Markup nit: OK and ERR should be marked \constant in running text. 2001-01-04 05:14:45 +00:00
Fred Drake 2a72712efe Update documentation to include the new functions, and use the more
explicitly-named bisect_right() in the example code.

This closes SF bug #127055.
2001-01-04 05:12:52 +00:00
Fred Drake 9c15fa7a0f Description of long(): A string parameter is no longer required to be
*decimal*.

This closes SF bug #127273.
2001-01-04 05:09:16 +00:00
Neil Schemenauer 48c2eb9165 Document the NotImplemented object. 2001-01-04 01:25:50 +00:00
Fred Drake d18722b99d Do not cache <img> tags for navigation icons as agressively; this fixes
bug #127151.
2001-01-02 22:08:48 +00:00
Fred Drake 2cba0f641f Improve description of else clause of the try/except/else statement.
This closes (again!) bug #127098.
2001-01-02 19:22:48 +00:00
Fred Drake cc97f8c609 Fix up an awkward sentence, pointed out by Chris Ryland <cpr@emsoftware.com>. 2001-01-01 20:33:06 +00:00
Thomas Wouters 8e2b6b5cc7 Change documentation of 'else' clause of 'try/except' to make clear that it
doesn't get triggered by 'return', 'break' or 'continue'. If the
'try-inside-continue' patch does not get accepted before next release, the
'or continue' should be removed ;P

Closes SF patch #103045 and SF bug #127098.
2000-12-31 22:52:59 +00:00
Andrew M. Kuchling be0630282e Fix doubled word 2000-12-26 16:14:32 +00:00
Andrew M. Kuchling 8694cc42ab Remove redundant reference to tab (since it = 'horizontal tab') 2000-12-26 16:09:37 +00:00
Andrew M. Kuchling e6bf85845f Document ERR and OK 2000-12-26 15:58:27 +00:00
Fred Drake 1dea760ca1 Make sure subsections are formatted into HTML pages with reasonable names. 2000-12-25 06:19:08 +00:00
Fred Drake f08cbb1771 Added information on the ExternalEntityParserCreate() method. 2000-12-23 22:19:05 +00:00
Andrew M. Kuchling 5caee408b8 Add 'see also' link to curses.panel 2000-12-22 22:06:43 +00:00
Andrew M. Kuchling 676634beda Added documentation for the panel wrapper module 2000-12-22 21:57:42 +00:00
Fred Drake e412e7a3a0 Fix lots of small markup nits.
Wrapped some long lines.
2000-12-21 17:04:31 +00:00
Andrew M. Kuchling 68a6f5a0a2 Document the window.overlay() and .overwrite() methods 2000-12-21 16:25:44 +00:00
Andrew M. Kuchling 68abe832b9 Fix typo 2000-12-19 14:09:21 +00:00
Guido van Rossum 5db5ba1ee3 Document the warnings module. 2000-12-19 06:01:23 +00:00
Fred Drake dea764d7f1 Updated string literals description to encompass Unicode literals and the
additional escape sequences defined for Unicode.
This closes bug #117158.
2000-12-19 04:52:03 +00:00
Guido van Rossum 1367b83797 Document warning categories. 2000-12-19 04:27:54 +00:00
Guido van Rossum 035f7e88c8 Clarify __repr__ and __str__. 2000-12-19 04:18:13 +00:00
Fred Drake 5b56765fe7 Added documentation on the ErrorHandler interface.
This closes bug #126034.
2000-12-19 04:07:54 +00:00
Guido van Rossum e22e4b2b59 Oops. The value "0 or +1" for the category argument of PyErr_Warn()
doesn't work.  Make it 0.  (Although it really *should* be 0 or +1 --
the refcount is incremented when it is raised as an exception, but not
otherwise.)
2000-12-19 03:58:11 +00:00
Guido van Rossum 9a18a7ed03 Document Pyerr_Warn().
Add an XXX comment at the beginning expressing disappointment over the
confusing way refcount behavior of arguments is documented.
2000-12-19 03:53:57 +00:00
Guido van Rossum 3dbb406335 Document Pyerr_Warn(). 2000-12-19 03:53:01 +00:00
Fred Drake 2b6d7bc151 Do not talk about "real" numbers; talk about "floats" or "floating point
numbers" instead; we have not described "reals" anywhere else in the
documentation, and this is not the place to change the story!

Reported by Keith Briggs <keith.briggs@bt.com>.
2000-12-18 13:50:24 +00:00
Neil Schemenauer e9e860faf3 Add support for gdbm2 open flags ('s' and 'u'). Add module constant
open_flags which contains the flags supported by gdbm.  Closes patch
#102802.
2000-12-17 07:14:13 +00:00
Fred Drake 5100133685 urlretrieve() description included explanation of "data" parameter, but
did not include it in the signature.

Fixed some markup nits.
2000-12-15 23:57:51 +00:00
Fred Drake 065cba1281 Added documentation for random.shuffle(). 2000-12-15 19:07:17 +00:00
Fred Drake 29c45a5e91 Grant Griffin <grant.griffin@honeywell.com>:
Clarify that invert() is a *bitwise* operation.
2000-12-15 05:41:49 +00:00
Andrew M. Kuchling 4fb588240f Document napms()
Add reference to demo directory
2000-12-15 01:03:23 +00:00
Fred Drake de77bc5468 For the title page, insert the package version number before the date.
This makes the title area more like the title are of the top-level
index, and puts the information more people are interested in first.
2000-12-14 18:36:12 +00:00
Fred Drake f0b315478b Update information on the locking() function, added the needed constants.
(Thanks for the info, Tim!)
2000-12-14 03:11:24 +00:00
Fred Drake 48971198c5 Finish a sentence that was left half-written! 2000-12-13 22:36:02 +00:00
Moshe Zadka dd802208a7 Changing allow_reuse_address's default value, and documenting it. 2000-12-13 20:39:22 +00:00
Fred Drake 24d6da3eae Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
useful explanations.
2000-12-13 19:34:38 +00:00
Fred Drake bc9c1b15cc Added descriptions of the defined exceptions and their mapping to the
DOM recommendation.
2000-12-13 17:38:02 +00:00
Guido van Rossum ff63f2023d "Documentation" for {}.popitem(). 2000-12-12 22:03:47 +00:00
Thomas Wouters dc90cc2b15 Additional docs for __iadd__ and family, closing SF bug #117178 and SF patch
#102169.
2000-12-11 23:11:51 +00:00
Fred Drake 2a22200ab4 Adjust explanation of operator precedence summary -- exponentiation groups
from right to left!

Closes bug #125391.
2000-12-11 22:39:24 +00:00
Fred Drake ed911b8cfb Added link to HTML version of the NumPy documentation.
This closes bug #124943.
2000-12-11 20:57:13 +00:00
Fred Drake 5255c791cc select.select(): Add note that though this function accepts empty lists,
using *only* empty lists may not be acceptable on all
                  platforms, with the specific caveat that it does not
                  work on Windows.  Also clarified list of acceptable
                  objects that may be in the lists, to let the user know
                  that file objects are not usable here on Windows.
2000-12-11 15:50:07 +00:00
Fred Drake 9a29dd6580 Lots of small improvements and bits of added information on the DOM API. 2000-12-08 06:54:51 +00:00
Fred Drake c3b18d7ca8 Fix error noted by Gerrit Holl (old; had been buried in my INBOX):
sequence repitition works just fine with long integers now, so we
should not say that only plain integers are allowed.
2000-12-07 04:54:02 +00:00
Fred Drake 0c47559352 Added a note that objects which emulate built-in types should only
implement as many of the relevant methods as make sense for the particular
information being modelled.
2000-12-07 04:49:34 +00:00
Fred Drake 16942f2224 Lots of additional information. Not done, but much better. 2000-12-07 04:47:51 +00:00
Fred Drake 4c12ee866b Another name! 2000-12-07 00:06:46 +00:00
Fred Drake fd4d29cf5d Typo caught by Jim Tittsler <jwt@onjapan.net>: They --> The 2000-12-07 00:03:24 +00:00
Fred Drake b62966c175 Note that, as of Python 1.6, the .returns_unicode attribute on parser
objects can be modified at any point with the expected results.
2000-12-07 00:00:21 +00:00
Barry Warsaw b6a54d2a2c _getframe(): New sys module function for getting at the stack frame.
Implements and closes SF patch #102106, with Guido's suggested
documentation changes.
2000-12-06 21:47:46 +00:00
Fred Drake 21e4dd0492 Two typos caught by /F; thanks! 2000-12-04 22:29:17 +00:00
Fred Drake e119c8fc61 Added a comment for ContentHandler.characters() explaining how to migrate
SAX1 code to SAX2, based on bug #123695.
2000-12-04 22:04:15 +00:00
Fred Drake 57657bce94 Update Moshe Zadka's email address to one works and might last a while. 2000-12-01 15:25:23 +00:00
Moshe Zadka 5725d1eb03 Backing out my changes.
Improved version coming soon to a Source Forge near you!
2000-11-30 19:30:21 +00:00
Moshe Zadka 1a62750eda Added .first{item,value,key}() to dictionaries.
Complete with docos and tests.
OKed by Guido.
2000-11-30 12:31:03 +00:00
Fred Drake 827bb9fb3c Adjust to allow an explanation of the changes to be included in the
notification message.
2000-11-30 07:38:59 +00:00
Fred Drake e463f8e4cd A few small refinements to the table building code. 2000-11-30 07:17:27 +00:00
Fred Drake c01f6e691b Use a table to describe the keys to the locale information dictionary;
this is slightly easier to read than the list environment that had been
used.
2000-11-30 07:13:58 +00:00
Fred Drake e0b9deb3ce Use small tables instead of bare \item markers to describe the contents
of return tuples.  The bare \item took advantage of an implementation
detail when formatting in LaTeX, and was just wrong when generating HTML.
It also broke the XML conversion scripts, since there was no enclosing
list-like environment to contain them.
2000-11-30 07:12:54 +00:00
Fred Drake 1aaf5855f7 Added name. 2000-11-30 07:09:59 +00:00
Fred Drake 6b3f3f2861 In the first discussion showing how to handle exceptions from C, make the
Python equivalent actually equivalent to the C code.  Also, in the C code,
place the "goto" statements on a line by themselves for better visibility
of statements that affect control flow.

This closes bug #123398.
2000-11-29 15:48:22 +00:00
Fred Drake f65ab1bf10 Added entries reflecting the separation of the abstract DOM documentation
and the implementation docs for xml.dom.minidom.
2000-11-29 06:11:29 +00:00
Fred Drake eaf57aa44a Substantial re-organization of the DOM documentation. The abstract API
is now separated from the supplied standard implementation.  Not all
interfaces are documented yet, but the structure is better set up to do
so.

There is still a lot to do here, but the shape of the documentation is
coming into line.
2000-11-29 06:10:22 +00:00
Fred Drake 4a6f1df48c Fix broken backslashes in Unicode strings section.
This closes bug #123730.
2000-11-29 06:03:45 +00:00
Tim Peters 657ebef2ae Partial fix for SF bug 123730: extra backslash in tutorial. 2000-11-29 05:51:59 +00:00
Fred Drake ee814bf2c9 Added documentation for the Py_InitModule*() family of functions. 2000-11-28 22:34:32 +00:00
Fred Drake 83ff4af1a3 Added information on the use of Unicode with the StringIO and cStringIO
modules, otherwise the behavior is just plain confusing.
2000-11-28 16:24:28 +00:00
Fred Drake 0a0ef8696b Use a subclass of buildindex.Node to clean up the HTML and get the
ordering fixed up (this makes sure that "xml.dom" comes before
"xml.dom.minidom" in the Module Index, which was not true before because
some HTML cruft crept into the data structures).
2000-11-28 16:20:50 +00:00
Fred Drake 6763b31731 Added brief explanation of the \versionchanged for 1.5.2 (fixes formatting
for the HTML version).
2000-11-28 06:39:28 +00:00
Fred Drake 2fef3abc74 Two minor nits. 2000-11-28 06:38:22 +00:00
Fred Drake b7a52c9de3 Minor typo: \subsubsections --> \subsubsection 2000-11-27 20:10:18 +00:00
Tim Peters c113465a49 SF non-bug 123520: fleshed out the tutorial's lambda example a little more. 2000-11-27 06:38:04 +00:00
Fred Drake fed0d09075 Conversion.write_ordinal(): Not used, remove it. 2000-11-22 17:59:32 +00:00
Fred Drake 691a5a7c09 Convert the LaTeX "tie" (~) to a simple space.
Add support for some combining characters.

Remove unnecessary imports and dependencies on PyXML and esistools.
2000-11-22 17:56:43 +00:00
Fred Drake 382a75d0e9 Update to reflect the process changes.
Remove the SGML aspects; there's too much XML momentum to worry about
the SGML flavor at this point.
2000-11-22 16:58:25 +00:00
Fred Drake 97be740cd8 Update the rules to separate the two phases for the ESIS generation,
entirely so that debugging can be performed independently.
2000-11-22 16:54:20 +00:00
Fred Drake d397f236d5 Add support for (relatively) recent additions and changes to python.sty,
and one more standard LaTeX macro.
2000-11-22 16:45:19 +00:00
Fred Drake 0ac000cd54 Updates to reflect pending changes to the XML conversion process. 2000-11-22 16:42:37 +00:00
Fred Drake 78489a362e Do not use \verb in the Python documentation -- it makes parsing the LaTeX
sources more difficult and other tools do not always work well with it.
Since we have better markup for this case, just fix it.
2000-11-22 16:06:16 +00:00
Andrew M. Kuchling 620ec9d1ca Document the new setupterm() function 2000-11-18 17:57:33 +00:00
Fred Drake 17383b9ad7 Added information about the %r string formatting conversion. Added note
about the interpretation of radix 0 for int(), and added description of
the optional radix argument for long().  Based on comments from Reuben
Sumner <rasumner@users.sourceforge.net>.

This closes bug #121672.
2000-11-17 19:44:14 +00:00
Fred Drake 977fe96a05 Oops, back out change committed by accident! This is not ready, and
breaks things.
2000-11-17 19:09:34 +00:00
Fred Drake 2ed27d3189 Note that readframes() returns data in linear format, even if the original
is encoded in u-LAW format.  Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.

This closes bug #122273.
2000-11-17 19:05:12 +00:00
Fred Drake aa126e1e21 Corrected a number of typos reported by Gilles Civario
<gcivario@users.sourceforge.net>.

This closes bug #122562.
2000-11-17 18:20:33 +00:00
Fred Drake d99e534de6 Fixed typos and bug in the second example, reported by Scott Schram
<schram@users.sourceforge.net>.

This closes bug #122236.
2000-11-17 18:04:03 +00:00
Tim Peters a3100de9ce Fix for SF bug 122176: Error in rotor module documentation. 2000-11-14 21:43:01 +00:00
Fred Drake da7b5bedb3 More names... 2000-11-07 16:09:53 +00:00
Andrew M. Kuchling f16e0ed76c Patch #102278: add tparm() function to _curses module 2000-11-07 03:35:24 +00:00
Fred Drake a776cea71a Document the proper exception to be raised by I/O operations on closed
files; error reported by Ng Pheng Siong <ngps@post1.com>.

Make sure that various special object attributes are properly indexed.
2000-11-06 20:17:37 +00:00
Fred Drake 9dce7b3737 Make sure we clean up the index data each time it is written by LaTeX. 2000-11-03 02:57:31 +00:00
Fred Drake 4bc0aed3a6 Fix cut & paste error that describes three paramters when there are only
two [bug #119729].

Update use of distutils.sysconfig that "broke" when Greg W. changed the API
[bug #119645].
2000-11-02 21:49:17 +00:00
Fred Drake 19647ca318 Typo: writeable --> writable
Reported by Erno Kuusela <erno@iki.fi>.
2000-11-01 03:12:34 +00:00
Fred Drake 5942b439b3 define_module(): Change the "index sub-item" for definitions at module
scope to be " (in module <name>)" instead of
                  " (in <name>)" to be consistent with \withsubitem
                  usage throughout the documentation.  This achieves
                  consistency in indexing throughout the documentation.
2000-10-30 06:24:56 +00:00
Fred Drake ec77e6590d Fix \withsubitem so that it actually works if the only indexing macro in
the content body is the \ttindex macro, which seems to match actual usage.

Adjust \funcline to restore the "index sub-item" for functions to be
" (in module <name>)" instead of " (in <name>)".  This is need to match
uses of \withsubitem throughout the documentation.  (Not ideal, but
gets achieves consistency.)
2000-10-30 06:22:22 +00:00
Fred Drake d34cfcb4c7 Revise the message to be a little nicer.
Have the mail sent to the python-dev and Doc-SIG lists.
2000-10-29 13:21:45 +00:00
Fred Drake a33c566138 Avoid using \withsubitem and \ttindex internally; they have not proven
to be very robust.  Using \index directly fixes a lot of entries in the
index that had to be specifically read to determine that they had the
wrong parenthesized description.
2000-10-29 05:19:16 +00:00
Fred Drake efffe8e317 Many small markup revisions to be more consistent with markup elsewhere,
and to provide more consistent indexing.

Added an index entry.

Added documentation for the error and XMLParserType objects.
2000-10-29 05:10:30 +00:00
Fred Drake 8fdb6383dc Update author information. 2000-10-28 04:08:38 +00:00
Fred Drake 3aecfc9681 Explained that os.path.basename() may return something different from the
basename program, as suggested by Gregor Hoffleit <gregor@hoffleit.de>.

This closes bug #119485.
2000-10-26 21:38:23 +00:00
Fred Drake 4532dc1bd9 Do not require packages that are not needed. 2000-10-26 21:13:22 +00:00
Fred Drake 351960de94 Normalize the HTML generated for table headers. 2000-10-26 20:14:58 +00:00
Fred Drake 6c7fc77d22 Minor simplification. 2000-10-26 20:01:09 +00:00
Fred Drake ca92eeba6f Update the dependency information to allow the other Makefiles to handle
as much of this as possible.  Avoids propogating information about how
various outputs relate (or don't!).
2000-10-26 19:26:47 +00:00
Fred Drake 956698819f Noted that building the info version requires the HTML::Element package,
and provided instructions for getting it installed.
2000-10-26 19:01:46 +00:00
Fred Drake 585698aa59 All acknowledgements have been moved to the Doc/ACKS file.
Adjusted to reflect the rename of Setup.in to Setup.dist.

Added pointer to the "Distributing Python Modules" manual in the
appropriate place.
2000-10-26 17:19:58 +00:00
Fred Drake eff9a87fcc Lots of small markup adjustments for consistency with the rest of the
documentation.
2000-10-26 16:41:03 +00:00
Fred Drake bce920129c Typo: shorted --> shorter
This closes bug #117706.
2000-10-25 23:22:54 +00:00
Fred Drake 53143bec9b Since LookupError can be raised by sys.setdefaultencoding(), we should not
document it as only being a base class, not matter how unlikely this is
to affect normal users.
2000-10-25 21:05:29 +00:00
Fred Drake 1dba66cb72 Marc-Andre Lemburg <mal@lemburg.com> noted that the encode() string method
was added in 2.0.
2000-10-25 21:03:55 +00:00
Fred Drake 8940fafabd Additions from Marc-Andre Lemburg <mal@lemburg.com>, documenting
getdefaultencoding() and setdefaultencoding().
2000-10-25 21:02:55 +00:00
Fred Drake 1491cace2a Several additions and updates based on text from Marc-Andre Lemburg
<mal@lemburg.com>.

Lots of markup reformatting to make it easier for me to read & maintain.
2000-10-25 20:59:52 +00:00
Fred Drake 7497bd3e3d Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
whatever is being documented, not necessarily Python.  (These tools are
also used for the How-To documents, etc.)


get_version_text():  New function.  Returns HTML fragment describing the
        software version and documentation date.

bot_navigation_panel():  Include the result of get_version_text() at the
        end, so the information is available on every page.
2000-10-25 16:18:10 +00:00
Fred Drake d04592a46b Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
whatever is being documented, not necessarily Python.  (These tools are
also used for the How-To documents, etc.)
2000-10-25 16:15:13 +00:00
Fred Drake e4359952c0 Remove some HTML from the PYTHONDOCS fragment defined here. 2000-10-25 16:12:04 +00:00
Fred Drake 6a11960ed4 Minor addition; add a little formatting to the release information that
will be added to Doc/perl/l2hinit.perl shortly.
2000-10-25 16:10:46 +00:00
Fred Drake 7ceab739d0 Make this actually work now that the tool is checked in here instead of
just sitting around in my working directory.
2000-10-24 19:59:55 +00:00
Fred Drake 277a21150b Added entries for the xml.dom.minidom module. 2000-10-24 02:35:42 +00:00
Fred Drake 669d36f02c Paul Prescod <paul@prescod.net>:
Documentation for the xml.dom.minidom module & Python DOM API.

FLD:  I have revised the markup in some places and added a few minor
details to Paul's text, but that's it.  Given the substantial
structural differences with the bulk of the presentation, I will be
making additional revisions over the next few days.
2000-10-24 02:34:45 +00:00
Fred Drake f61eac425a Remove second horizontal line below table headers; it is just too
distracting.
2000-10-24 02:18:30 +00:00
Fred Drake 8902442e2f Added exception to the rule that the buffer returned by PyString_AsString()
and PyString_AsStringAndSize() for strings that were just created using
PyString_FromStringAndSize(NULL, n).

This closes bug #117377.

Added warning about passing NULL to the concrete object functions; many of
them use the appropriate Py<Type>_Check() test, but do not check for NULL.

"de-allocated" --> "deallocated"
2000-10-23 16:00:54 +00:00
Fred Drake 246f65f2bb Correct the name of a parameter in the description of the register()
function.

This closes bug #117467.
2000-10-23 15:41:13 +00:00
Fred Drake 0579eb042c More names. 2000-10-22 03:23:58 +00:00
Fred Drake 8c2fd49cc3 Added missing entry for invert() function.
Added table mapping abstract operations to syntax to functions, based on
a suggestion from Bob Weiner <weiner@beopen.com>.
2000-10-22 03:19:30 +00:00
Greg Ward 7ef2ba796b Minor tweaks to catch up with the current code in a few spots.
Wrote the "Distutils Configuration Files" section.
2000-10-22 01:40:08 +00:00
Fred Drake d097d48200 Flesh out the "LaTeX Primer" some more. 2000-10-20 20:51:31 +00:00
Fred Drake 860106ae90 Update the display of some floating point values at the interactive prompt
to reflect current behavior.
This closes SourceForge bug #117305.

Made a reference to the library reference a hyperlink.

Fixed some minor markup nits.
2000-10-20 03:03:18 +00:00
Fred Drake a577aa2003 Remove the bzip2 archives from the "distfiles" target. There are not
enough downloads to keep this around.
2000-10-19 13:25:15 +00:00
Fred Drake 4a41f54958 Two more names. 2000-10-19 05:58:03 +00:00
Fred Drake 692565c9e9 Helper scripts used in published the "development" snapshots of the
Python documentation.
2000-10-19 05:54:51 +00:00
Fred Drake 63568aa9bb Revise the capitalization policy of \versionchanged explanation; the
explanation must now be capitalized.  This is more consistent with the
\see* explanation fields.

Added a lot of material to the "LaTeX Primer" section.
2000-10-19 05:36:10 +00:00
Fred Drake 4a152630ca Capitalize first letter of an explanation for a \versionchanged
annotation.
2000-10-19 05:33:46 +00:00
Andrew M. Kuchling a8d10785f1 Correction from David Bolen: the Windows version no longer crashes
on trying to import a 1.5 module
Bump the document version number
2000-10-19 01:42:33 +00:00
Andrew M. Kuchling 75afc0b914 Document the .lastindex and .lastgroup attributes of MatchObject 2000-10-18 23:08:13 +00:00
Fred Drake ba0a989988 Make all the \seemodule explanations consistent: start with a capitalized
letter and end with proper punctuation.  "Documenting Python" will be
updated accordingly so that this will be editorial policy for the Python
documentation.
2000-10-18 17:43:06 +00:00
Fred Drake 510dfbad3d Capitalize & use periods for \seemodule explanation parameter. 2000-10-18 16:47:52 +00:00
Andrew M. Kuchling ad6f2c8007 Bump version number -- this document is pretty much finished! 2000-10-17 13:02:42 +00:00
Fred Drake b4b401eda3 Update the links to the NumPy website and documentation, based on a
comment from Janko Hauser <jhauser@ifm.uni-kiel.de>.
2000-10-17 04:58:01 +00:00
Andrew M. Kuchling f155170f09 Correct form of FourThought's name 2000-10-16 14:19:21 +00:00
Fred Drake 89fb035248 For PyErr_Format(), note that the exception parameter can be a string or
class, but not an instance (since an instance will be created using the
formatted message string as the constructor parameter).
2000-10-14 05:49:30 +00:00
Fred Drake 3c8c2f9b77 Adjust the Macintosh manual to have the formatting dependencies for
manuals instead of howtos.
2000-10-14 05:47:17 +00:00
Fred Drake 21c9df7641 For os.stat() & friends, note that the time fields are returned as
floating-point values.
2000-10-14 05:46:11 +00:00
Fred Drake e764968649 Update dependencies for the Macintosh manual. 2000-10-14 05:44:32 +00:00
Fred Drake c25296a916 Update to include all the new chapters & sections.
Convert from a howto to a manual, so we can *have* chapters!
Comment out the macconsole module documentation; Think C seems to have
disappeared.
2000-10-14 05:41:17 +00:00
Fred Drake c7babad2a0 Remove everything that is not module documentation.
It is no longer needed here.
2000-10-14 05:39:08 +00:00
Fred Drake 8e850ee0f2 Fix some internal references that I botched. 2000-10-14 05:24:20 +00:00
Fred Drake 45aa573186 Chapter on how to use MacPython, by Bob Savage <bobsavage@mac.com>. 2000-10-14 05:09:42 +00:00
Fred Drake 4d0d621b66 Chapters on Mac Toolbox modules and other undocumented modules, ready to
be filled in with real information.  Contributed by Chris Barker
<cbarker@jps.net>.
2000-10-14 05:08:34 +00:00
Fred Drake 1bd905e901 Documentation for the aepack and aetypes modules, by Vincent Marchetti
<vincem@en.com>.
2000-10-14 05:06:24 +00:00
Fred Drake 8f6ca1518a Chris Barker <cbarker@jps.net>:
Small fixes.
2000-10-14 04:59:12 +00:00
Fred Drake eab58af841 Chris Barker <cbarker@jps.net>:
Various updates and additions.
2000-10-14 04:56:52 +00:00
Fred Drake 26fbd8b692 Chris Barker <cbarker@jps.net>:
Small clarification, remove the assertion that the module is temporary.
2000-10-14 04:55:15 +00:00
Fred Drake 658865c370 Chris Barker <cbarker@jps.net>:
Added summary of the strengths and weaknesses of the FrameWork module
and fixed some typos.
2000-10-14 04:53:31 +00:00
Fred Drake f459a09e9a Wrap a long line. 2000-10-14 04:49:36 +00:00
Fred Drake b6441e78fb More names. 2000-10-14 04:47:53 +00:00
Fred Drake eecdc7f47e A bunch of nits fix and some additional information added by Chris
Barker <cbarker@jps.net>.
2000-10-14 04:45:22 +00:00
Fred Drake 9d62943f24 Center the top line of the license page, to make it look just a little bit
cleaner.
2000-10-14 04:07:49 +00:00
Fred Drake 91eb3e8558 Update the release number and date. 2000-10-13 15:35:27 +00:00
Fred Drake 602aa77d2f Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for the codec base classes.
Lots of markup adjustments by FLD.

This closes SourceForge bug #115308, patch #101877.
2000-10-12 20:50:55 +00:00
Fred Drake babe326c65 Added entries for new files of SAX documentation. 2000-10-12 20:07:09 +00:00
Fred Drake 014f0e3394 Massive addition of SAX documentation from Martin von Loewis
<loewis@informatik.hu-berlin.de>.

Reorganized to be more like other parts of the documentation in its
arrangement, but with few content changes.

This closes SourceForge patch #101850.
2000-10-12 20:05:09 +00:00
Andrew M. Kuchling ec1722e8d4 Various minor additions and clarifications, mostly suggested by Jeremy 2000-10-12 03:04:22 +00:00
Fred Drake 7486c6b0ef Comment out a separator line, since all the others are commented out,
and it would look kind of silly if typeset.
2000-10-12 02:49:12 +00:00
Andrew M. Kuchling 6032c48b47 Add new section on the XML package. (This was the only major new 2.0 feature
left that wasn't covered.  The article is therefore now essentially complete.)
A few minor changes
2000-10-12 02:37:14 +00:00
Fred Drake 93615657ec Document the exceptions that now get raised on invalid parameters. 2000-10-11 22:27:51 +00:00
Fred Drake 6fe9bacb8c Make sure methods of ZipFile objects are in alphabetical order; the logical
groupings are still maintained.  Based on a comment by Steve Holden
<sholden@holdenweb.com>.
2000-10-11 18:56:00 +00:00
Fred Drake 2c4f554b78 Fixed a large number of small problems, mostly noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.
2000-10-10 22:00:03 +00:00
Fred Drake 66c9f0781d Note that the UserString/MutableString classes are far less efficient
than the built-in string types (suggested by Moshe Zadka
<moshez@math.huji.ac.il>).

Clarified what "can be converted to a string" means.

Fixed a few markup nits.
2000-10-10 20:58:48 +00:00
Fred Drake ef52f601ed Revise the examples not to use the "from socket import *", and adjust
one comment in the example for clarity.
2000-10-10 20:36:29 +00:00
Fred Drake 0fc6a67307 Remove duplicated text from urlopen() description, noted by Ka-Ping
Yee <ping@lfw.org> and probably others as well.
2000-10-10 20:23:10 +00:00
Fred Drake 77b76b6db6 Substantially revise to handle the fact that Python CVS is no longer in a
file-system accessible repository.  Add a little bit of smarts to convert
the cvsroot to an anonymous cvsroot the real one requires an authenticated
login to SourceForge; this avoids the SSH startup delay when doing the
checkout or export to get a fresh copy of the tree.
2000-10-10 19:35:40 +00:00
Fred Drake 3ece71327f Make it clear that copy_reg.pickle() should not be used for classes, but
only for extension types.

This partially fixes SourceForge bug #116295.
2000-10-10 18:36:02 +00:00
Fred Drake f8ca7d88c6 Fixed lots of small nits caught by Ka-Ping Yee <ping@lfw.org>. 2000-10-10 17:03:45 +00:00
Fred Drake 2d34cd3ecf Minor nit fixes based on suggestions from Ka-Ping Yee <ping@lfw.org>.
Added "See also" section with relevant RFC references.
2000-10-10 17:02:34 +00:00
Fred Drake 25407882ea Better synopsis based on suggestion from Ka-Ping Yee <ping@lfw.org>. 2000-10-10 16:59:53 +00:00
Fred Drake 4d3714b5c6 Better synopses based on suggestions from Ka-Ping Yee <ping@lfw.org>. 2000-10-10 16:56:41 +00:00
Fred Drake 6ff7aec2ab Move the documentation for the mutex module to be with the threading
and queue-management modules, since that is where the general context
for use in most cases.
2000-10-10 16:46:36 +00:00
Fred Drake 87d4a03ad7 Do not forget to build the acks.html file when building "all"! 2000-10-09 18:56:23 +00:00
Fred Drake 17a2b640e4 Work around annoyances in LaTeX2HTML. 2000-10-09 18:12:29 +00:00
Fred Drake 955e03bd68 Push xmllib to the end of the markup chapter since it is deprecated. 2000-10-09 18:11:24 +00:00
Fred Drake ecbd2aaa02 Another name. 2000-10-09 18:08:56 +00:00
Fred Drake 3383792c74 Denis S. Otkidach <ods@users.sourceforge.net>:
Correct description of leapdays() function.

This closes SourceForge patch #101840.
2000-10-09 15:27:31 +00:00
Fred Drake 77878413ba Hush the nanny. 2000-10-07 12:50:05 +00:00
Fred Drake 5d64421c23 Fix a couple of places where the descriptions of *_GET_SIZE() macros said
they were similar to *_GetSize(); should be similar to *_Size().

Error noted by William Park <parkw@better.net>.
2000-10-07 12:31:50 +00:00
Fred Drake c2bac8745d Include more information from the docstrings. 2000-10-06 21:07:14 +00:00
Fred Drake 3a844a2822 Another name. 2000-10-06 21:00:40 +00:00
Fred Drake 519744409b Fix really bad typo, noted by Neil Schemenauer <nas@arctrix.com>. 2000-10-06 20:16:50 +00:00
Fred Drake c6243e4e08 Add notes on the requirements for subclasses.
This closes SourceForge bug #115928.
2000-10-06 20:04:48 +00:00
Fred Drake 2e06c209dc Revise the versioning information to say that this was revised in 1.6,
not added then, and note what the change was (ncurses, change to a package).
2000-10-06 20:01:23 +00:00
Fred Drake 062ea2e70b Made a number of revisions suggested by Fredrik Lundh.
Revised the first paragraph so it doesn't sound like it was written
when 7-bit strings were assumed; note that Unicode strings can be used.
2000-10-06 19:59:22 +00:00
Fred Drake d88d0a1d5b It turns out that Guido does not like or encourage the use of the term
"disciplines" for the __*__() methods, so they should be referred to as
"methods" or "special methods", as appropriate in context.
2000-10-06 19:39:47 +00:00
Fred Drake 476491396e Use the cvsinfo module instead of a module stuff off in my personal
collection.
2000-10-06 16:37:47 +00:00
Fred Drake 72fbd8264c Support module to help work with checked-out CVS trees. 2000-10-06 16:36:48 +00:00
Fred Drake 5d63a39983 is_zipfile() description: Use the same name for the parameter as the
code, in case someone wants to use it as a keyword paramter.

ZIP_DEFLATED description:  Do not reveal the specific value of the
      constant, since code should only use the symbolic name.
2000-10-06 15:29:56 +00:00
Fred Drake 50a22a4cad Added a name. 2000-10-06 15:25:01 +00:00
Neil Schemenauer 410cb6be8f The _PyTuple_Resize() last_is_sticky flag must now always be false. 2000-10-05 19:38:24 +00:00
Andrew M. Kuchling 9351dd2084 Document the lookbehind assertions (closing bug#115119) 2000-10-05 15:22:28 +00:00
Andrew M. Kuchling 7a90db6131 Document expand() method of MatchObjects 2000-10-05 12:35:29 +00:00
Fred Drake 85788edca4 Better add at least a short docstring to the module! 2000-10-05 05:20:55 +00:00
Fred Drake 6522192c0b Add a link to the new acks.html file. 2000-10-05 05:17:29 +00:00
Fred Drake 3705e59c04 Add rules for generating the acks.html file at the top of the document tree. 2000-10-05 05:16:56 +00:00
Fred Drake 702f2d763e Ignore the acks.html file, since it is generated. 2000-10-05 05:16:12 +00:00
Fred Drake f23431da11 New script to convert the ACKS file to a nicely formatted HTML file.
Uses the new support module.
2000-10-05 05:15:29 +00:00
Fred Drake 01a110be57 Use the new support module instead of including all the getopt
processing and style information directly.
2000-10-05 05:14:26 +00:00
Fred Drake ca2b2e04e1 Factor out some of the presentation and shared code from mkmodindex and
a mkackshtml (not yet checked in).
2000-10-05 05:11:57 +00:00
Fred Drake 4beff43e45 List of acknowledgements culled from CVS checkin logs and memory.
The documentation ACKS list will be maintained separately from the
CPython ACKS list.
2000-10-05 04:05:30 +00:00
Fred Drake 559b5c8892 Update for next planned release. 2000-10-05 03:24:00 +00:00
Neil Schemenauer b2c2c9e977 - update Neil's email address 2000-10-04 16:34:09 +00:00
Fred Drake 15f06661c1 Added deprecation notices to atof(), atoi(), and atol(), recommending
use of the float(), int(), and long() built-ins instead.

Fixed minor markup nit elsewhere (use of \optional).
2000-10-04 13:59:52 +00:00
Fred Drake c71c23e392 Added \versionchanged comment to os.popen() noting that it was unreliable
in earlier versions of Python; this is useful information for people
interested in writing code that is portable across Python versions.

Suggested by Peter Funk <pf@artcom-gmbh.de>.
2000-10-04 13:57:27 +00:00
Fred Drake 63eb6300a9 Remove styling information that conflicts with or duplicates the stylesheet;
different browsers resolve the conflicts differently, and the "proper"
resolution is not what we actually want.

Reported by Peter Funk <pf@artcom-gmbh.de>.
2000-10-04 13:39:24 +00:00
Andrew M. Kuchling d44dc3ca6f Rewrites to section on new development process, after Usenet discussion
of the text
2000-10-04 12:40:44 +00:00
Fred Drake 0b4e25d0c0 Use \obindex{...} instead of \indexii{...}{type} in many places; this is
more consistent with other index entries in the documentation.
2000-10-04 04:21:19 +00:00
Fred Drake 1654b43ef7 Preliminary tool to troll through the CVS logs and LaTeX sources for
the names of people that should be in the ACKS file.

This relies on some personal code that is not yet available, but should
be by the time we release 2.0c1.
2000-10-03 22:10:25 +00:00
Fred Drake 1319e3ecbc Remove old note that os.popen() on Windows is unreliable; this is no
longer true.
2000-10-03 17:14:27 +00:00
Fred Drake 13589c6a52 Bump the release number for the upcoming candidate. 2000-10-03 16:50:48 +00:00
Fred Drake e35360ffd0 Jim Ahlstrom sent a few corrections to my changes. (Thanks!) 2000-10-03 15:16:31 +00:00
Fred Drake 5f84c9b55e $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
definition provided by previously loaded configuration code, and
        testing whether it's defined isn't needed since the default was
        false anyway.

get_link_icon():  Add support for $OFF_SITE_LINK_ICON_HEIGHT and
        $OFF_SITE_LINK_ICON_WIDTH, giving the dimensions of the icon
        being used.  This can make for faster page display.  Both are
        optional.

make_my_titlegraphic():  Fix insertion of the off-site icon link.

do_env_funcdesc():  Remove debugging print.

handle_rfclike_reference():  Remove trailing colon from first line; it
        doesn't really make sense and looks bad if we add an icon to
        mark off-site links.
2000-10-03 06:05:25 +00:00