Commit Graph

3415 Commits

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

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

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

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

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

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

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

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

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

Added an index entry.

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

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

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

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


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

bot_navigation_panel():  Include the result of get_version_text() at the
        end, so the information is available on every page.
2000-10-25 16:18:10 +00:00
Fred Drake d04592a46b Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
whatever is being documented, not necessarily Python.  (These tools are
also used for the How-To documents, etc.)
2000-10-25 16:15:13 +00:00
Fred Drake e4359952c0 Remove some HTML from the PYTHONDOCS fragment defined here. 2000-10-25 16:12:04 +00:00