Commit Graph

3537 Commits

Author SHA1 Message Date
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
Fred Drake 58a2dff7f4 Replace minimal \seetext references with better annotated \seerfc
references, telling the reader more about what to expect at the other end
of the links.
2000-10-03 05:56:55 +00:00
Fred Drake 4dc1a6d6ba Added some comments on the interaction of reload() and extension modules.
Based on comments from Chris Barker <cbarker@jps.net>.
2000-10-02 22:38:09 +00:00
Fred Drake 296b8f5bd2 Add deprecation note since the XML support is shaping up. 2000-10-02 22:14:09 +00:00
Fred Drake 8093b70a12 Minor change to attributes so that the stylesheets can have better control. 2000-10-02 21:26:28 +00:00
Fred Drake 427802470a Substantially revised documentation for the zipfile module, partially based
on revised text from Jim Ahlstrom <jim@interet.com>.

This closes SourceForge bug #115681.
2000-10-02 20:56:30 +00:00
Fred Drake 5df72f0632 Minor stylesheet nit. 2000-10-02 17:36:27 +00:00
Fred Drake 7a40c0702e make_icon_filename(): Convenience function to turn a partial filename
into a usable filename using $ICONSERVER and
                       $IMAGE_TYPE as needed.

get_link_icon():  Function to examine a URL and return the string to use
                  to insert an icon if the link points off-site, if needed
                  and $OFF_SITE_LINK_ICON is set.

Adjusted appropriate places to use these new functions.
2000-10-02 14:43:38 +00:00
Fred Drake f6791f3d12 Minor usage fix.
Add a note that some way of reliably detecting the use of KDE would be
really nice.
2000-10-02 03:42:43 +00:00
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
Greg Ward 0bc5953e83 Added skeletal "Building Extensions: Tips and Tricks" section. This
is where all the FAQs about extension-building will be answered.
2000-09-30 21:06:40 +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 ffe58ca6ef Reversely --> Conversely
This closes SourceForge bug #115673.
2000-09-29 17:31:54 +00:00
Fred Drake 31b761e326 Spelling: internalization --> internationalization
Fixed displays of the interactive prompt in running text.
These close SourceForge bug #115658.

Also:

Updated discussion of tuple unpacking to reflect the general ability
to unpack any sequence type.  Explained that it is possible to create
tuples which contain mutable values, and noted in the dictionary
section that such tuples cannot be used as keys.

Noted that .pyc and .pyo files can be run directly when provided as
the script parameter to the interpreter, and slightly clarified
comments about using modules with only the byte compiled code.

Removed some XXX comments that are no longer relevant.
Removed commented-out paragraph about __private names being experimental.

Adjusted markup for consistency in some places.
2000-09-29 15:17:36 +00:00
Fred Drake 4ce4f2eedd os.startfile() documentation, based on text from Tim Peters. 2000-09-29 04:15:19 +00:00
Fred Drake 329796d634 Consistency nits, untabify. 2000-09-28 20:41:16 +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
Andrew M. Kuchling fc1b60e3da Fix double negative spotted by matt@mondoinfo.com 2000-09-27 02:49:24 +00:00
Andrew M. Kuchling be870dd96f Added a section describing the new development process. Part of it
comes from two comp.lang.tcl postings of mine, with much rewriting
   and expansion of the material.
Note that 2.0 will be released in the autumn, not the summer.
2000-09-27 02:36:10 +00:00
Andrew M. Kuchling 3ad4e74870 Wrote text for features added between 2.0b1 and b2.
Minor rewrites, and added the CVS ID in a comment.
2000-09-27 01:33:41 +00:00
Andrew M. Kuchling 118ee9680e Fixed error in explanation of codec decode_func pointed out by Gregg Hauser,
and rewrote paragraph a bit.
2000-09-27 01:01:18 +00:00
Fred Drake 0b71ceaeff Note that including Python.h includes limits.h when available. 2000-09-26 05:51:50 +00:00
Greg Ward 15f5e2aa0f Remove a ?? in the description of Mac OS support. 2000-09-26 02:54:43 +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
Andrew M. Kuchling 6d4addd1f4 Update URL for Python 2.0 2000-09-25 14:40:15 +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
Fred Drake 891150bdf2 Added documentation for the new PyModule_*() convenience functions.
This closes SourceForge patch #101233.
2000-09-23 03:25:42 +00:00
Fred Drake 1fa9365066 Added refcount information for the *_InPlace*() API series.
This closes SourceForge bug #114287.
2000-09-22 18:19:37 +00:00
Fred Drake c0e6c5beb2 PyNumber_Coerce() returns an int, not a PyObject *. 2000-09-22 18:17:49 +00:00
Fred Drake 3764b6b67e Fix the way we found relevant cfuncdesc lines; PREFIX was not a regular
expression!
2000-09-22 17:55:32 +00:00
Fred Drake 38178fd951 use_sans_serif(),
use_italics():  Remove both functions, inlining use_italics() at its
                only call site.

init_myformat():  Uncomment line so that some internal markup does not
                  get generated, since it is not properly removed later.
                  (Fix on aspect of SourceForge bug #114749.)

Modified call to process_commands_wrap_deferred(), removing \code from
the list since it had a bad interaction with other changes in some contexts.
2000-09-22 17:05:04 +00:00
Fred Drake a9dd2eeb51 Update versioning for the next Python release. 2000-09-22 16:20:23 +00:00
Fred Drake e71912c241 Update RELEASE for the next Python release. 2000-09-22 16:18:19 +00:00
Fred Drake 4c6d21a790 Fix some minor nits about the use of \optional in parameter lists. 2000-09-22 15:46:35 +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 343ad7a572 Correct some bitrot; some things have become inaccurate in the tutorial.
<file>.readlines() does not call <file>.readline() internally anymore,
and the sizehint parameter should be mentioned briefly.

Some displays of floating point numbers needed to be updated due to the
change in the repr() of floats (from 1.6).

Both issues were noted by Aahz <aahz@panix.com>.
2000-09-22 04:12:27 +00:00
Fred Drake f89259786a Denis S. Otkidach <ods@users.sourceforge.net>:
Show how code can be written to handle __getslice__ & friends in a way that
is compatible with pre-2.0 versions of Python while still working with the
"new" way of handling slicing.

Additional explanation added by Fred Drake.

This closes SourceForge patch #101388.
2000-09-21 22:27:16 +00:00
Fred Drake d68442b164 Lots of minor fixes, many suggested by Detlef Lannert
<lannert@uni-duesseldorf.de>.
2000-09-21 22:01:36 +00:00
Fred Drake 00fb4160d3 Added dependencies on the bug-reporting text. 2000-09-21 21:37:09 +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 cb0a0b3e80 New text about how to report bugs in Python and the documentation. 2000-09-21 21:32:14 +00:00
Marc-André Lemburg 3578b77312 Special case the "s#" PyArg_Parse() token for Unicode objects:
"s#" will now return a pointer to the default encoded string data
of the Unicode object instead of a pointer to the raw UTF-16
data.

The latter is still available via PyObject_AsReadBuffer().
2000-09-21 21:08:08 +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 da72b93a01 Add new environments: longtableii, longtableiii, and longtableiv, to
support long tables which might break across page boundaries.  Otherwise
identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
Fred Drake 2964268db5 Allow the LaTeX markup descriptions to use the \moreargs and \unspecified
macros in the argument list position.
2000-09-21 15:53:54 +00:00
Fred Drake 31575ce817 Note that __getitem__() may receive a slice object as the index;
reported by Detlef Lannert <lannert@uni-duesseldorf.de>.
2000-09-21 05:28:26 +00:00
Fred Drake 02997491c1 Document directories are not always named with three characters any more;
reported by Detlef Lannert <lannert@uni-duesseldorf.de>.
2000-09-21 05:26:43 +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 df84facf0d .use_latex(): Make this a little smarter so that it only runs pdflatex
once if all the temporary files are available from building
               a DVI file.  This can avoid two runs of pdflatex.
2000-09-20 05:49:09 +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
Marc-André Lemburg d1ba443206 This patch adds a new Python C API called PyString_AsStringAndSize()
which implements the automatic conversion from Unicode to a string
object using the default encoding.

The new API is then put to use to have eval() and exec accept
Unicode objects as code parameter. This closes bugs #110924
and #113890.

As side-effect, the traditional C APIs PyString_Size() and
PyString_AsString() will also accept Unicode objects as
parameters.
2000-09-19 21:04:18 +00:00
Fred Drake 8d27f898b2 Moshe Zadka <mzadka@geocities.com>:
Document the __contains__() method.
(Patch slightly modified by FLD.)

This closes SourceForge patch #101387.
2000-09-19 18:21:25 +00:00
Fred Drake 1156f62348 Many small clarifications, including many suggested by email. 2000-09-19 18:10:05 +00:00
Fred Drake 02c7082745 make_nav_sectref(): Create more minimal HTML, hanging the class attribute
off an existing anchor tag if available (I think it
                     always is, but am not completely sure).
2000-09-19 15:36:19 +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 1cca9e29f9 Make the <body> tag match those of the generated HTML; rely on the style
sheet instead of encoding anything there.
2000-09-16 21:31:33 +00:00
Fred Drake 7be440da1a Document \cfuncdesc, \ctypedesc, and \cvardesc. 2000-09-16 21:23:25 +00:00
Fred Drake 1681627ebf Push more of the display control into the style sheet. 2000-09-16 20:40:44 +00:00
Guido van Rossum c96ec6ef2b Document new APIs PyOS_getsig() and PyOS_setsig().
(Is there no macro to document a typedef?)

Fred, please check my latex!
2000-09-16 16:30:48 +00:00
Fred Drake 634fc574e1 Use a really ugly hack that depends on output processing by LaTeX2HTML.
This replaces the tilde character with the string ";SPMtilde;", which
LaTeX2HTML converts to a tilde on output.
2000-09-16 14:16:57 +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