Commit Graph

3472 Commits

Author SHA1 Message Date
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
Fred Drake ab2f9f766f Update link to the zlib homepage. 2000-09-16 05:07:03 +00:00
Fred Drake f29107447a Update the link to Andrew Kuchling's crypto code. 2000-09-16 05:02:24 +00:00
Fred Drake 91fc9319fa Update link to the FIPS PUB 180-1 (PDF is available, but not PostScript). 2000-09-16 04:59:33 +00:00
Fred Drake 630d0f0974 Update some stale links. 2000-09-16 04:21:22 +00:00
Tim Peters 78fc0b57df Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
FRED, please check my monkey-see-monkey-do Tex fiddling!
2000-09-16 03:54:24 +00:00
Fred Drake 6a547c7878 Fix a link -- there is no starship.python.org! 2000-09-15 22:11:24 +00:00
Fred Drake 7c25f3df85 Add some comments on the available implementations that this module can
use.

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

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

Fix typo where it was already mentioned.

This closes SourceForge bug #110619.
2000-09-15 04:12:56 +00:00
Fred Drake f3d41272c6 Before running LaTeX2HTML, remove all the HTML files from the output
directory.  This avoids acretion of HTML from previous runs which may
have a new name; this would have avoided a lot of the packaging problems
related to changing labels from the old distutils documentation.
2000-09-14 22:25:47 +00:00
Fred Drake aaa238585f When there is a Module Index, make sure the icon actually links to it. 2000-09-14 22:20:41 +00:00
Fred Drake 4dfad57235 Add a reference to the sha module, noting that SHA is considered more
secure.  Suggested by Erno Kuusela <erno@iki.fi>.
2000-09-14 21:47:32 +00:00
Fred Drake b9fd468ded Convert "See also" section to use \seetitle. 2000-09-14 21:46:22 +00:00
Fred Drake 33e0beaf77 Did not include the sha module documentation dependency. 2000-09-14 21:42:38 +00:00
Fred Drake 6ba0a3c30a Denis S. Otkidach <ods@users.sourceforge.net>:
Minor fix in documentation of code module.
(Clarifies output destination for default implementation of the write()
method.)
2000-09-14 20:42:53 +00:00
Fred Drake 7a666b83c8 Remove reference to the stdwin-based windowed debugger, since stdwin
is gone.

Make a module reference into a hyperlink.
2000-09-14 20:32:17 +00:00
Fred Drake bd2d4f1252 Use the \setshortversion macro to specify the abbreviated version number.
This partially addresses SourceForge bug #114318.

Fix the release number -- this is supposed to be the *Python* release,
not the documentation release!  The later is given by the combination of
the Python release number and the date.  Add a comment so I can keep it
straight.
2000-09-14 20:28:26 +00:00
Fred Drake d5d0435617 Use \shortversion in a number of places.
This partially addresses SourceForge bug #114318.
2000-09-14 20:24:17 +00:00
Fred Drake 3cdb89d5ec do_cmd_shortversion(),
do_cmd_setshortversion():  Implementation for new markup.

convert_args():  New helper function.

do_cmd_optional():  Modified to understand when it is called from within
                    a convert_args() invocation.

do_env_funcdesc(),
do_env_funcdescni(),
do_cmd_funcline(),
do_cmd_funclineni(),
handle_classlike_descriptor(),
do_env_methoddesc(),
do_end_methoddescni(),
do_cmd_methodline(),
do_cmd_methodlineni():  Modified to use helper convert_args().

The convert_args() helper and related changes fix the generation of HTML
for the \optional markup, so that bogus </var>...<var> is not generated.
This closes SourceForge bug #113800.
2000-09-14 20:17:23 +00:00
Fred Drake af2b71466a \shortversion,
\setshortversion:  New markup to help deal with Python having a "real"
                   version number and an abbreviated version number
                   used to create pathnames to the library installation.
2000-09-14 20:11:05 +00:00
Fred Drake 1fe3b82371 Avoid reference to specific versions of Python where possible.
This partially addresses SourceForge bug #114318.
2000-09-14 18:25:41 +00:00
Fred Drake 933f0c38ef Avoid reference to specific versions of Python where possible.
This partially addresses SourceForge bug #114318.
2000-09-14 18:12:48 +00:00
Fred Drake 66d32b1e12 Add some index entries to make it easier to find information on
%-formatting of strings.
2000-09-14 17:57:42 +00:00
Barry Warsaw ddef8887db Include a link to Francois's po-utils. 2000-09-13 12:04:47 +00:00
Greg Ward 8c56259a3d Fix install directories on Mac OS (now that the "install" command
does the right thing).
2000-09-13 00:12:37 +00:00
Greg Ward 1ed49eeb29 Changed/added a bunch of section labels so HTML files will be named nicely. 2000-09-13 00:00:58 +00:00
Greg Ward e24f05e25b Improve Windows and Mac OS-specific instructions for running the
setup script.  Also added a comment about how it *should* work on Mac OS.
2000-09-12 23:55:19 +00:00
Greg Ward 078fc0816d Typo fix -- it's 'ext_modules', not 'extensions'. 2000-09-12 23:08:53 +00:00
Fred Drake e92cdba105 Documentation is good. Let's release more. 2000-09-12 21:08:55 +00:00
Fred Drake 0b25053ca0 Make this script handle PyVarObject* functions as well as PyObject*
functions.
2000-09-12 20:47:29 +00:00
Fred Drake 31f5550fbe Thomas Wouters <thomas@xs4all.net>:
Reference manual docs for augmented assignment.

This closes SourceForge patch #101418.
2000-09-12 20:32:18 +00:00
Fred Drake 7740a01096 Thomas Wouters <thomas@xs4all.net>:
Fix up some of the PyNumber_*() documentation.
Add documentation for the InPlace API calls.
2000-09-12 20:27:05 +00:00
Fred Drake f913e542be Vladimir Marangozov <Vladimir.Marangozov@inrialpes.fr>:
Here are some changes to the C API docs. The memory examples & API have
been updated because one malloc family is gone (Py_Malloc).
You'll see other small additions to the "building new types" section
for completeness and some cleanup at the end of the memory section.
2000-09-12 20:17:17 +00:00
Fred Drake c56817353d Re-wrapped some wide comments.
Fixed Module Index generation.
2000-09-12 20:13:04 +00:00
Fred Drake b7cf378023 Add note that the various \see* macros are only defined in the context
of a seealso environment.
2000-09-12 19:58:10 +00:00
Fred Drake 5dc6104729 Change the title of the link to the document index to be more specific. 2000-09-12 19:53:18 +00:00
Fred Drake ae86d43f11 Add a reference item pointing to the Namespaces in XML recommendation.
Convert the existing reference items to \seetitle markup.
2000-09-12 17:53:48 +00:00
Fred Drake 48449985f4 \seetitle: New macro for building reference list content. 2000-09-12 17:52:33 +00:00
Fred Drake 1349437e4c When referring to namespaces, always say "namespaces" instead of
"name spaces".

Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
Fred Drake 81cccb7563 Added documentation for PySequence_Fast() and PySequence_Fast_GET_ITEM(). 2000-09-12 15:22:05 +00:00
Fred Drake aafc0c4595 When formatting the API manual, use the generated api.tex rather than
the original, since the refcount information has been added there.
2000-09-12 15:20:54 +00:00
Skip Montanaro b655939d69 add index entries for list comprehensions 2000-09-11 16:31:55 +00:00
Fred Drake 88fa9627b1 Some updates and fix a bunch of really small consistency nits. 2000-09-11 05:23:25 +00:00
Fred Drake 08c5d0cdcb Add documentation for the \pep and \seepep macros. 2000-09-11 05:22:30 +00:00
Greg Ward 14deaaec12 Minor tweaks to get rid of some '\XXX' remarks. 2000-09-11 00:33:15 +00:00
Fred Drake 643d76d735 Add support for new \pep, \seepep, excclassdesc markup.
Update processing of module synopsis tables (found at the beginning of
most chapters of the library reference) to reflect changes in the
processing pattern of recent versions LaTeX2HMTL.  Requires most
recent change to SynopsisTable.pm.

This does not fix the module index problem.
2000-09-09 06:07:37 +00:00
Fred Drake 4e607964d1 excclassdesc: New environment. For use in documenting class-based
exceptions which have interesting constructor signatures.

\pep, \seepep:  New macros.  Equivalent to \rfc and \seerfc, but
        referring to the PEP series instead of the Internet RFC
        series of documents.
2000-09-09 06:01:25 +00:00
Fred Drake 75c6cb909c Add support for a filename to record the name of the node in which the
table will be presented.  Accessor methods are used to access the
attribute.
2000-09-09 05:53:41 +00:00
Fred Drake 1b194f927d Add a reference to the material on string methods. 2000-09-09 05:34:06 +00:00
Fred Drake f96e0d203b Various clarifications and minor nits fixed. Affected descriptions of
input(), locals(), reload(), unicode(), and zip().
2000-09-09 03:33:42 +00:00
Fred Drake 1172a85175 Really minor consistency nit. 2000-09-09 03:31:17 +00:00
Fred Drake 66571cc20c Improve a couple of references to the language reference, making them
hyperlinks to relevant sections.

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

Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
Fred Drake 1c4efad770 Move the "See also" section to a location more consistent with other
module sections.  Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
Fred Drake 621d2bee1c Move description of UserString.MutableString to a location more typical
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
Fred Drake 1c25803647 Add a brief section on linking Python as an embedded scripting language.
This closes SourceForge bug #110833.
2000-09-08 22:54:53 +00:00
Fred Drake 90f876798f When building the HTML packages, make sure we pick up all the HTML files
at the top level of the tree.
2000-09-08 21:54:44 +00:00
Fred Drake a61bfa84c9 Add a general "About" page and link to it from the index page.
This fixes SourceForge bug #113810.
2000-09-08 21:53:22 +00:00
Fred Drake 6c8affe590 Remove an item that no longer needs to be done for 2.0. 2000-09-07 21:11:45 +00:00
Fred Drake ae3a15c396 Make the HTML more XHTML-friendly.
Small nits in the layout of the generated markup.
2000-09-07 20:07:41 +00:00
Fred Drake 31edf4defb Wrap some long lines.
Note that \file and \filenq do not work inside section titles.
2000-09-07 20:06:07 +00:00
Fred Drake 5cd0cefbd2 Remove the specific date -- back in development mode. 2000-09-07 18:56:29 +00:00
Fred Drake d0726c3cd9 \file is not allowed in section titles -- converting to PDF fails due to
weird macro-expansion issues.  A better solution may be available in the
future, but this will do for now.

Add an index entry.  More should probably be added as well.
2000-09-07 18:55:08 +00:00
Fred Drake 88c023b863 Remove comment about -X and string exceptions. Error noted by
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
Fred Drake 6300bd42a4 Added note about Python version this was added for. 2000-09-07 14:01:40 +00:00
Fred Drake 77a6c9ece5 Minor markup nits around use of \optional. 2000-09-07 14:00:51 +00:00
Greg Ward b652897456 Greatly enhanced the section on creating built distributions; in
particular wrote up creating RPMs in detail.
Other scattered improvements.
2000-09-07 02:40:37 +00:00
Andrew M. Kuchling 4d46d38292 Add new section "What About Python 1.6?"
Document some things in the 2.0 NEWS files that should be mentioned here.
2000-09-06 17:58:49 +00:00
Andrew M. Kuchling d500e44297 Removed mention of the winreg module, since it was deleted from 2.0b1 2000-09-06 12:30:25 +00:00
Fred Drake 8b2e8f846c Added a \versionadded statement to the getfqdn() description. 2000-09-06 02:22:16 +00:00
Greg Ward 54589d4d97 General overhaul of the "Creating a Source Distribution" section --
better explanation of manifest files, in particular.
2000-09-06 01:37:35 +00:00
Fred Drake 239e1d5e50 Fix mkhowto so that the bookmarks for the PDF work for both "howto" and
"manual" class documents.
2000-09-05 21:45:11 +00:00
Fred Drake 8bdf0bf705 Fix PDF generation.
The \\ introduced in the \author in boilerplate.tex broke the PDF
generation because line breaks are not allowed in the "Document Info"
metadata stored in the PDF file.  This changes the line break to
a ", " (comma-space) in that context.
2000-09-05 15:19:56 +00:00
Fred Drake 82de71dae8 Minor nit to make this work a little better with the PDF generation fix.
This does not change the HTML or PostScript output.
2000-09-05 15:11:56 +00:00
Fred Drake 8ff4cd7512 Minor markup revisions for consistency with the rest of the documentation. 2000-09-05 13:50:21 +00:00
Fred Drake 0d83f68fc9 Added entry for mmap module. 2000-09-05 13:49:30 +00:00
Fred Drake c28425f4c6 Update license according to the LICENSE file in the source tree. 2000-09-05 04:32:26 +00:00
Fred Drake 05e4ef01a2 Set the date. 2000-09-05 03:13:38 +00:00
Greg Ward 47f99a6174 Fleshed out the section on the setup config file, setup.cfg.
Added a few clarifying footnotes and cross-references.
Various minor tweaks.
2000-09-04 20:07:15 +00:00
Andrew M. Kuchling 5e08a01a98 Various corrections pointed out by Detlef Lannert 2000-09-04 17:59:27 +00:00
Moshe Zadka 57a5932f13 Update documentation for PyErr_Format, because the function has changed.
Connected to patch 100895
2000-09-01 09:47:20 +00:00
Barry Warsaw 21fbd540ed Document the new optional argument "rest" on the transfercmd(),
ntransfercmd(), and retrbinary() commands.  This closes SF patch
#101187.
2000-09-01 06:32:32 +00:00
Fred Drake e0d9a83bea Document PyImport_AppendInittab(), PyImport_ExtendInittab(), and
struct _inittab.

This closes SourceForge bug #111499.
2000-09-01 05:30:00 +00:00
Jeremy Hylton b709df3810 refactor __del__ exception handler into PyErr_WriteUnraisable
add sanity check to gc: if an exception occurs during GC, call
PyErr_WriteUnraisable and then call Py_FatalEror.
2000-09-01 02:47:25 +00:00
Fred Drake 65faf118b6 Fix markup error and minor consistency nit. 2000-08-31 19:35:56 +00:00
Jeremy Hylton ee5adfbae6 add user-modifiable recursion_limit
ceval.c:
    define recurion_limit (static), default value is 2500
    define Py_GetRecursionLimit and Py_SetRecursionLimit
    raise RuntimeError if limit is exceeded
PC/config.h:
    remove plat-specific definition
sysmodule.c:
    add sys.(get|set)recursionlimit
2000-08-31 19:23:01 +00:00
Fred Drake aef0e890b5 Document the limitation that urllib does not work with proxies which
require authenication.  This is an implementation limitation rather than
required behavior, and may be fixed in the future.

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

Fix minor problem with EXTENDED_ARG description markup..
2000-08-31 16:26:35 +00:00
Fred Drake 7e861bd1b3 Update some version information for tools based on prodding from Greg Ward. 2000-08-31 15:29:38 +00:00
Greg Ward 1365a300a1 Get rid of "sec:" prefix that slipped into a couple of \label's. 2000-08-31 14:47:05 +00:00
Sjoerd Mullender 1c8feae411 New method getnamespace.
Since the application never gets to see the namespace abbreviation
used in the XML document, but some applications may need to know them,
we provide this method.
2000-08-31 10:27:00 +00:00
Fred Drake f730fc3e4e Be a little more careful to avoid including style information in the
generated markup.

Don't be careless with the navigation icons!  We should use the blank
icon where there is not anyplace to go for a particular position in the
navigation bar.
2000-08-31 07:19:07 +00:00
Fred Drake 3eb7c126cd Always room to remove more formatting from the HTML! 2000-08-31 07:15:57 +00:00
Fred Drake 501b926da9 Move common parameters to mkhowto to a variable, add up-link from the
generated documents to the document index.
2000-08-31 07:00:17 +00:00
Fred Drake dfa539d770 Add --up-link and --up-title parameters to allow linking the top level
of the generated document to an external index.  These correspond to the
-up_url and -up_title parameters of LaTeX2HTML.
2000-08-31 06:58:34 +00:00
Fred Drake 3be2074758 Push some table header formatting to the style sheet; this also helps
separate some of the ties between l2hinit.perl and python.perl.

Revamp the "title page" construction to allow more flexibility.
2000-08-31 06:22:54 +00:00
Fred Drake 0154fea5f4 Remove obsolete scripts. 2000-08-31 06:15:30 +00:00
Fred Drake 8bc627a402 Add --l2h-init option, which can augment the standard LaTeX2HTML
initialization with additional Perl files.  This can be given more
than once.
2000-08-31 06:14:38 +00:00
Fred Drake b9b4c5b560 Centralize the processing logic for LaTeX documents into the mkhowto script;
do not use mkdvi.sh or mkhtl.sh any more.

This slows down building all versions of the documentation, but if you are
only building one format, it does not matter.
2000-08-31 06:12:35 +00:00
Fred Drake fcab76350a Relocate the popen2 documentation since it is now substantially more
portable.
2000-08-31 06:09:26 +00:00
Fred Drake 17e6343d2d Document PyOS_CheckStack().
Fix a couple of really minor markup nits.
2000-08-31 05:50:40 +00:00
Fred Drake 33642acef5 Added note about documenting the SSL support in the socket module. 2000-08-31 05:08:00 +00:00
Fred Drake eacc4fc5e6 Push a little more here to avoid style information in the generation
scripts as much as possible.
2000-08-30 15:02:13 +00:00
Fred Drake 4973b35991 Remove the reference to stdwin. The comment was still true, but no
longer meaningful to a new user, since stdwin is long gone.
2000-08-30 14:33:02 +00:00
Skip Montanaro 7b828a6a56 doc changes to parallel changes to calendar.py module 2000-08-30 14:02:25 +00:00
Andrew M. Kuchling 3cdb5761c5 Fix markup error 2000-08-30 12:55:42 +00:00
Fred Drake d576e9df5f Markup revisions. Nothing was actually required to be able to format it,
but many conventions were broken.
2000-08-30 04:19:20 +00:00
Fred Drake 47eceeaaa4 Added a couple of links to online documentation. Reasonable since this
file is not used in the online documentation.
2000-08-30 03:30:40 +00:00
Barry Warsaw 28b815f28a Oops, spell MAL's name right. 2000-08-30 03:28:17 +00:00
Barry Warsaw 0691a6b8ed Documentation for the gettext module. 2000-08-30 03:27:10 +00:00
Barry Warsaw 058365aec5 Added libgettext.tex 2000-08-30 03:26:17 +00:00
Andrew M. Kuchling 43737641c2 Removed forgotten text in list comprehensions section (taken from the Haskell
description of listcomps and used as inspiration)
Rearranged sections (which accounts for much of the size of the diffs)
Added section on augmented assignment
Mentioned 'print >>file'
Broke up the "Core Changes" section into subsections
2000-08-30 00:51:02 +00:00
Fred Drake 699f98c09a Move a little more here. 2000-08-29 21:57:34 +00:00
Fred Drake fcb8725de5 Add a --style option to allow specifying an alternate CSS style sheet for
HTML generation; the machinery was there but no option to set it was
defined.

Simplify some of the path-math since we can assume a recent version of
Python.
2000-08-29 18:15:05 +00:00
Fred Drake 78430b655f Add a comment noting that the dependency information is stored in
Makefile.deps.
2000-08-29 16:30:21 +00:00
Fred Drake 7e1a1d0c89 These files are not part of the current plan. 2000-08-29 06:08:06 +00:00
Barry Warsaw 33f785fc1e Document "print >> None" 2000-08-29 04:57:34 +00:00
Moshe Zadka a1a4b5916b Closing patch #101120 -- After everyone agreed. 2000-08-25 21:47:56 +00:00
Fred Drake 0308ff8652 Add reference to RFC 2396 in "See also" section.
Minor cleanups.
2000-08-25 17:29:35 +00:00
Fred Drake dfca4dc503 Revised documentation relevant to SourceForge patch #100837
(simplify making HTTP POST requests).

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

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

This closes SourceForge patch #100837.
2000-08-24 01:06:40 +00:00
Fred Drake 8377f5debf Make sure Thomas Wouters has enough to do. ;-)
(Some of this is in-progress; this also serves as a reminded to me to
check this out once it is written.)
2000-08-24 00:50:27 +00:00
Fred Drake 093272ea85 Charles G. Waldman <cgw@fnal.gov>:
Update the dis module documentation to reflect the EXTENDED_ARG opcode.
2000-08-24 00:37:50 +00:00
Skip Montanaro 323fe5df6a fix list comprehension discussion to use \keyword macro instead of simply
quoting keywords.
2000-08-23 17:03:34 +00:00
Skip Montanaro 297bf7ceb5 update commonprefix doc to make sure user is aware it works
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
2000-08-23 16:58:32 +00:00
Skip Montanaro 46dfa5f4ed require list comprehensions to start with a for clause 2000-08-22 02:43:07 +00:00
Barry Warsaw 9087688581 Describe the new PRINT_ITEM_TO and PRINT_NEWLINE_TO opcodes. 2000-08-21 17:19:00 +00:00
Barry Warsaw 8c0a242289 PEP 214, Extended print Statement, has been accepted by the BDFL.
Document the extended print form.  Fred, please double check the
markup!
2000-08-21 15:45:16 +00:00
Andrew M. Kuchling 120beb6b67 Strengthen the warning against using SerialCookie and SmartCookie.
(If they're security holes, should they be documented at all?)
Minor rewrites.
2000-08-20 23:33:50 +00:00
Thomas Wouters 8bad612881 Disallow "import mod.submod as m", because the result is ambiguous. Does it
load mod.submod as m, or mod as m ? Both can be achieved differently, and
unambiguously. Also attempt to document this restriction (editor
appreciated!)

Note that this is an artificial check during compile, because incorporating
this in the grammar is hard, and then adjusting the compiler to do the right
thing with the right nodes is harder.
2000-08-19 20:55:02 +00:00
Fred Drake 15446d344d Add entry for Cookie module. 2000-08-19 16:55:31 +00:00
Fred Drake e5c7352201 Make it format.
Adjust markup for hyperlinking to the relevant RFCs.
Give it a little organization.
Minor nits.
2000-08-19 16:54:57 +00:00
Moshe Zadka 1b07f2bcf6 Initial revision. Markup unchecked. 2000-08-19 14:11:41 +00:00
Fred Drake 512bb72fb0 As pointed out by Denis S. Otkidach <den@analyt.chem.msu.ru>, xrange()
returns an xrange object, not a range object, despite the name of the
source file they're implemented in.

In the list of comparison operators, list != before <>, since <> is
described as obsolescent.
2000-08-18 03:12:38 +00:00
Fred Drake a00738259f Adjust the way __getslice__() is marked as deprecated; this will also
stand out more.
2000-08-18 02:42:14 +00:00
Fred Drake 304faf944c Fix a markup error that caused formatting to fail.
Lots of minor markup adjustments as well.
2000-08-18 02:15:55 +00:00
Andrew M. Kuchling 59ecafa526 Mention the new 'import X as Y' syntax 2000-08-17 23:37:01 +00:00
Andrew M. Kuchling 0690c86a2a Document the returns_unicode attribute 2000-08-17 23:15:21 +00:00
Thomas Wouters 5215225ea1 Apply SF patch #101135, adding 'import module as m' and 'from module import
name as n'. By doing some twists and turns, "as" is not a reserved word.

There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
Thomas Wouters 1d75a79c00 Apply SF patch #101029: call __getitem__ with a proper slice object if there
is no __getslice__ available. Also does the same for C extension types.
Includes rudimentary documentation (it could use a cross reference to the
section on slice objects, I couldn't figure out how to do that) and a test
suite for all Python __hooks__ I could think of, including the new
behaviour.
2000-08-17 22:37:32 +00:00
Fred Drake 68add2e938 Remove an item that's been done. 2000-08-17 22:32:01 +00:00
Fred Drake dd611b0070 A little more text, and some really minor cleanups. 2000-08-17 22:31:23 +00:00
Fred Drake e581bb30c4 Small cleanups, and note when zip() entered the menagerie. 2000-08-17 22:30:30 +00:00
Fred Drake b32aa5ecef Revise the comments about the exceptions module to not refer to source
code; it is not sufficiently readable now that it in written in C, and
is less likely to be available to end users.
2000-08-17 22:29:31 +00:00
Fred Drake 25699f99f4 Martin v. Loewis <martin@loewis.home.cs.tu-berlin.de>:
Document opcodes added to support extended call syntax.
2000-08-17 22:19:26 +00:00
Fred Drake de9fec5f99 \citetitle: Format the title, not the optional URL! 2000-08-17 04:25:59 +00:00
Andrew M. Kuchling 2d2dc9fde5 Add section on list comprehension
Comment out the unwritten XML section
mymalloc.h -> pymem.h
2000-08-17 00:27:06 +00:00
Fred Drake 1aebadf0e5 Ka-Ping Yee <ping@lfw.org>:
Further examples of list comprehensions.
2000-08-16 21:44:03 +00:00
Fred Drake 5772c86816 Document socket.getfqdn(). 2000-08-16 14:21:42 +00:00
Andrew M. Kuchling 2337f5519a Mention setdefault() method for dicts 2000-08-16 02:52:37 +00:00
Thomas Wouters caa658d047 Apply SF patch #101151, by Peter S-K, which fixes smtplib's passing of the
'helo' and 'ehlo' message, and exports the 'make_fqdn' function. This
function should be moved to socket.py, if that module ever gets a Python
wrapper.
2000-08-15 19:30:36 +00:00
Fred Drake d341579178 Fix error made in applying Thomas's patch. 2000-08-15 18:44:10 +00:00
Fred Drake a1e214a1ed Thomas Wouters <thomas@xs4all.net>:
Update the grammar to reflect the most recent changes to list
comprehensions.
2000-08-15 17:54:49 +00:00
Fred Drake d066f6d780 Fix markup bug that prevented formatting.
Adjusted some markup for consistency with the rest of the documentation
and creation of the proper index entries.
2000-08-15 17:47:09 +00:00
Barry Warsaw 0be4346da6 Describe the b2a_hex() and a2b_hex() functions (a.k.a. hexlify() and
unhexlify() respectively).
2000-08-15 06:08:00 +00:00
Barry Warsaw 4ef4be53ac Added description of the md5.hexdigest() method. 2000-08-15 06:00:28 +00:00
Fred Drake 34c391d743 Correct the reference count information for the parameters of
PyErr_Restore().
2000-08-15 04:36:16 +00:00
Fred Drake a2b6ad6e27 Guido pointed out that all names in the sys module have no underscore, 2000-08-15 04:24:43 +00:00