Commit Graph

3429 Commits

Author SHA1 Message Date
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