Commit Graph

3585 Commits

Author SHA1 Message Date
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
Fred Drake 6bd8b252e0 For bug reporting, point to the SourceForge bug tracker instead of the
old Jitterbug interface.
2000-08-14 16:35:05 +00:00
Fred Drake 68e2915fc7 Document the byte_order value in the sys module. 2000-08-14 15:47:30 +00:00
Fred Drake 107b9679c4 Document the range type, as suggested by Denis S. Otkidach
<den@analyt.chem.msu.ru>.
2000-08-14 15:37:59 +00:00
Fred Drake 510d08bfe4 In the section on the "Very High Level Layer", address concerns brought up
by Edward K. Ream <edream@users.sourceforge.net> about FILE* values and
incompatible C libraries in dynamically linked extensions.  It is not clear
(to me) how realistic the issue is, but it is better documented than not.

This closes SourceForge bug #111520.
2000-08-14 02:50:21 +00:00
Fred Drake 81f7eb6c6b Fix some markup errors that prevented formatting, and one that didn't. 2000-08-12 20:08:04 +00:00
Skip Montanaro 803d6e5451 list comprehensions. see
http://sourceforge.net/patch/?func=detailpatch&patch_id=100654&group_id=5470

for details.
2000-08-12 18:09:51 +00:00
Fred Drake 4ca744c70e Added information for PyEval_EvalCode().
Fixed a couple of typos (new references are represented by "+1", not "1").
2000-08-12 03:39:47 +00:00
Fred Drake 4de96c2fd8 Added Marc-Andre Lemburg's documentation for string methods, with some
massaging for markup consistency.  This closes SourceForge patch #101063.

Added Unicode strings and buffer objects to the list of sequence types.

Small markup nits elsewhere.
2000-08-12 03:36:23 +00:00
Thomas Wouters 0be5aab04d Merge UNPACK_LIST and UNPACK_TUPLE into a single UNPACK_SEQUENCE, since they
did the same anyway.

I'm not sure what to do with Tools/compiler/compiler/* -- that isn't part of
distutils, is it ? Should it try to be compatible with old bytecode version ?
2000-08-11 22:15:52 +00:00
Fred Drake a8d7341f63 PyRun_InteractiveOne(),
PyRun_InteractiveLoop():  Added descriptions.

PyExc_WindowsError:  Added to list of standard exceptions and added note
                     about the right preprocessor symbol to use to protect
                     code that uses it.
2000-08-11 20:39:29 +00:00
Fred Drake 46479d3740 Some minor clarifications and added some index entries. 2000-08-11 20:34:27 +00:00
Fred Drake 3ac977e39c O_BINARY: Documented this constant; omission noted by David Ascher.
access():  Corrected availability statement; error pointed out by
           Tim Peters.
2000-08-11 20:19:51 +00:00
Fred Drake 241551c16c do_env_cfuncdesc(): Push as much of the generated HTML into one place
as possible for better readability.  Revise a comment.
2000-08-11 20:04:19 +00:00
Fred Drake a8e484c8f5 getopt(): revise description of long_options parameter slightly so it will
be less confusing; add a paragraph separation so that comments about
	the options and long_options parameters don't have references that
	are easily misinterpreted.

Adjust the interactive examples to not need the string module.

Add an example showing how the module is commonly used in a script.
2000-08-11 19:55:06 +00:00
Fred Drake 7932ed0ac4 Added material about documenting packages, so that the use of module
markup for packages is clear.
2000-08-11 17:37:33 +00:00
Fred Drake f40706375a Include the document dependencies earlier so that documents are rebuilt
when they need to be.
2000-08-11 17:36:21 +00:00
Fred Drake 4e15945fff Markup errors: \cfuntion -> \cfunction 2000-08-11 17:09:23 +00:00
Fred Drake 7d45d34ed7 ANY becomes void, to reflect the requirement for ANSI C. 2000-08-11 17:07:32 +00:00
Peter Schneider-Kamp 10e1bf2f64 remove all occurence of math.rint() from the sources
(and yes, "Currintly" also counts <0.5 wink>)
2000-08-10 04:23:30 +00:00
Eric S. Raymond 65983372f0 More on noutrefresh. 2000-08-09 21:49:31 +00:00
Eric S. Raymond 1ebd3f6c4b Tweak curses.wrapper so it initializes colors if they are available. 2000-08-09 21:11:07 +00:00
Fred Drake 3fe9a98c95 Correct markup error. 2000-08-09 14:37:05 +00:00
Fred Drake fc1f9229f4 Correct version number at which the curses.ascii module was introduced. 2000-08-09 14:36:11 +00:00
Fred Drake ec4b2af6bb Fix a few markup errors and lots of small consistency issues.
Add "See also" link to curses.wrapper module from curses module.
2000-08-09 14:34:48 +00:00
Fred Drake cb0fc9c2ce fix_font(): Handle one more case for the magical first column of tables. 2000-08-09 13:45:04 +00:00
Guido van Rossum 8141cf5c76 Barry's patch to document the new setdefault() method. Slightly
clarified the summary for default() in the table to indicate the side
effect.
2000-08-08 16:15:49 +00:00
Vladimir Marangozov f9d20c3786 Neil Schemenauer: GC enable(), disable(), isenabled() interface.
Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>
2000-08-06 22:45:31 +00:00
Greg Ward 2afffd42fa Wrote the "Describing extension modules" section. 2000-08-06 20:37:24 +00:00
Greg Ward 1d8f57a5a4 A bundle of wording improvements, corrections, clarifications, updates,
and so forth.
2000-08-05 00:43:11 +00:00
Andrew M. Kuchling b9fb1f23fe Mention Include/my*.h cleanup 2000-08-04 12:40:35 +00:00
Andrew M. Kuchling 581f33a4cb Added zip() builtin 2000-08-04 12:35:23 +00:00
Eric S. Raymond 5a007693c1 Documented curses.wrapper and curses.textpad. 2000-08-04 07:35:41 +00:00
Fred Drake ed13b4a5a6 Break the "Python Services" chapter into two: "Python Runtime Services"
(still at the start of the manual), and "Python Language Services" (late
in the manual).  Moved "Restricted Execution" to just before "Python
Language Services."
2000-08-03 21:18:18 +00:00
Marc-André Lemburg 8b9835cdb2 Added descriptions of the new parser markers for PyArg_ParseTuple(). 2000-08-03 19:38:07 +00:00
Fred Drake cc2b81e7f3 \py@varvars: Merge the various definitions to be the simplist one that
does everything needed, and discard the older stuff that is not
	being used.
2000-08-03 17:38:30 +00:00
Fred Drake 8b168ba505 int() description: Fix markup to avoid image generation for math mode.
zip() description:  Fix broken markup, three small markup consistency nits,
	and one really minor usage nit.  Introduce use of \moreargs instead
	of hardcoding "..." with \optional.
2000-08-03 17:29:13 +00:00
Fred Drake 3d5a04ab18 do_cmd_moreargs(),
do_cmd_unspecified():  New functions to reflect previously unused markup.

do_cmd_file():  Simplified generated markup to only make use of the
	existing stylesheet.

do_cmd_makevar():  Make the markup more stylesheet-friendly.
2000-08-03 17:25:44 +00:00
Barry Warsaw faefa2a885 Both PEP 201 Lockstep Iteration and SF patch #101030 have been
accepted by the BDFL.

Added documentation for zip() builtin.
2000-08-03 15:46:17 +00:00
Fred Drake 6c7a46a2f0 Rob Hooft <rob@hooft.net>:
Description of fcntl():  Added description of what can go wrong.
2000-08-02 20:53:51 +00:00
Mark Hammond 21a4764b9a As requested by Fred - mention that in the future a winreg module may make a comeback. 2000-08-01 23:49:50 +00:00
Peter Schneider-Kamp f917bf6080 fixing a minor spelling mistake 2000-08-01 00:07:17 +00:00
Fred Drake fbd3b45bb7 Stop lying about [].pop() being experimental! There is no backing it out
at this point.
2000-07-31 23:42:23 +00:00
Peter Schneider-Kamp 5a65c2d436 added count, extend, index, pop and remove to arraymodule 2000-07-31 20:52:21 +00:00
Fred Drake 4640e13259 Change as suggested by Peter Funk <pf@artcom-gmbh.de>:
Move around the navigational links on the left-hand side of the navigation
bar to be more like the cursor keys.
2000-07-31 20:13:23 +00:00
Fred Drake 3d83fc3ab1 Change as suggested by Peter Funk <pf@artcom-gmbh.de>:
Create a hyperlink between the language reference and documentation for
the built in functions.
2000-07-31 20:08:23 +00:00
Fred Drake e39dab6ce1 Organized a little bit; merged in some items from the 1.5.2p2 branch that
did not get handled.
2000-07-31 18:18:27 +00:00
Fred Drake e7aa5dc5bb Update to indicate the appropriate version of LaTeX2HTML. Update pointer
for retrieving new versions.
2000-07-31 17:56:58 +00:00
Fred Drake 85d14c9d02 Many changes to work with newer versions of LaTeX2HTML. This has been
tested with version 99.2beta8.
2000-07-31 17:53:45 +00:00
Fred Drake 1915754ec9 Small changes to reflect changes in LaTeX2HTML support for newer versions
of LaTeX2HTML.
2000-07-31 17:47:49 +00:00
Fred Drake 1e75e1776f Two minor nits from Gerry Weiner (no working email address) about
describing the methods of dictionaries.
2000-07-31 16:34:46 +00:00
Fred Drake b8aa2619c7 Always pass the split level to LaTeX2HTML as a command line option since
newer versions only process one initialization file, and do so at a
different time than previous versions.
2000-07-31 15:55:22 +00:00
Fred Drake 578a3f9638 Moshe Zadka <mzadka@geocities.com>:
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
2000-07-31 15:45:46 +00:00
Fred Drake 885082ca67 Update, 'cause Guido said it should be this way. 2000-07-31 14:31:28 +00:00
Fred Drake 10853c9835 Finally fixed the much-reported bug about "~" in a couple of example.
This time, it was reported by Skip.
2000-07-28 13:51:27 +00:00
Eric S. Raymond b924bd4610 Second round of curses documentation improvements. Completes and extends
documentation for function keys, special characters.
2000-07-27 21:10:02 +00:00
Fred Drake 518e55c7f2 Rip out the information about the PSA, since the fate of that is not
certain.

Update the information about the mailing list, using the python.org
address instead of cwi.nl, and point to the pipermail archives.  Also
update the daily average message count (at the risk of scaring people
off), using the mail archive at http://www.egroups.com/group/python-list
for the first half of 2000 for statistical information.
2000-07-27 20:55:12 +00:00
Andrew M. Kuchling 1962fb59f3 Document tiget{flag,num,str} 2000-07-26 02:59:13 +00:00
Fred Drake 1cb3a9ecef Add entries for the distutils documents to the directories table. 2000-07-25 19:27:17 +00:00
Fred Drake 498c18f4d0 Only use one initialization file for LaTeX2HTML; more recent versions only
use the last one specified on the command line instead of all of them.
Smaller changes to reflect updated support.
2000-07-24 23:03:32 +00:00
Fred Drake e1b304db37 Fix small typos and markup consistency nits. 2000-07-24 19:35:52 +00:00
Eric S. Raymond 6899660a81 First round of curses documentation improvements; correct errors, flesh out
entry point descriptions.
2000-07-24 03:28:40 +00:00
Skip Montanaro d372521ec0 added doc for isatty() 2000-07-19 17:30:58 +00:00
Skip Montanaro 7cb1524586 added documentation for new functions {get,set}_history_length 2000-07-19 16:56:26 +00:00
Thomas Wouters f9b526dbfd More of Rob W. W. Hooft's spelling fixes. The only ones left now are the
distutils patches, which I'll leave to the distutils maintainers.

Tip: review the patch like this:

grep "^[\!+-] " <patchfile>

To get a quick and easy way to review the actual changes. Most of the
changes are single-line ones, anyway.
2000-07-16 19:05:38 +00:00
Thomas Wouters f8316638af Rob W. W. Hooft's spelling fixes for the Library Reference. I hope
SourceForge doesn't choke on this batch :-)

I'm not entirely sure this is 100% correct. The patch changes an
\index{persistency} to \index{presistence}, and I don't know what \index{}
does. But it seems to do so persi--er, consistently, so I hope it isn't a
problem.
2000-07-16 19:01:10 +00:00
Eric S. Raymond f868de6491 Document the second round of ConfigParser changes. 2000-07-14 15:00:02 +00:00
Andrew M. Kuchling 8c46b30e0a Document PyObject_AsFileDescriptor 2000-07-13 23:58:16 +00:00
Fred Drake 91826ed2a9 Improve the descriptions of expected exceptions for __getitem__(),
__setitem__(), and __delitem__().  Based on related comments from
Barry Warsaw.
2000-07-13 04:57:58 +00:00
Andrew M. Kuchling 8d2f2b2db2 From Sam Rushing's Medusa, via SF patch #100858: add & document
os.seteuid(), os.setegid(), os.setreuid(), os.setregid().
2000-07-13 01:26:58 +00:00
Fred Drake bdcf91fda0 Documentation for the gc module. Text from Neil Schemenauer
<nascheme@enme.ucalgary.ca>, markup & minor revisions from Fred
Drake.
2000-07-12 04:22:53 +00:00
Eric S. Raymond 7ae3a5e79d Resynchronize the TeX docs with (a) the module docstring, and (b) my recent
fix to the code to make it behave like the module docstring.
2000-07-12 02:56:15 +00:00
Fred Drake 7399b9e6e4 Moshe Zadka <mzadka@geocities.com>:
Update the "in" / "not in" description to accomodate the current use
of the __contains__() discipline.  This patch also incorporates
suggestions from Marc-Andre Lemburg <mal@lemburg.com>, minor markup
revisions from Fred Drake, and some rewording of the first affected
paragraph (also from Fred).

Closes SourceForge patch #100831.
2000-07-11 19:43:47 +00:00
Fred Drake acab3d61e9 Change the table in the pyexpat.errors module to a series of datadesc
elements (since the table was pretty screwed up); this is how it is done
elsewhere in the manual.

I could use some help creating descriptions of the specific error
identifiers (input conditions that lead to each error, etc.).
2000-07-11 16:30:30 +00:00
Eric S. Raymond 417c489def Give ConfigParser the capability to set as well as read options, and to write
a representation of the configuration state in .ini format that can be read
back in by a future read() call.  Thus this class is now a back end
for .ini editors as well as parsers.

This patch is complete and tested, but exposes a bug in the ConfigParser
implementation which I have not yet fixed.  Because case information is
discarded during parsing, the output of write() has its case smashed.

I wrote this for a SourceForge interface script called forgetool.
Documentation for the new entry points included.
2000-07-10 18:11:00 +00:00
Greg Stein c2844af87b needs a space 2000-07-09 16:27:33 +00:00
Andrew M. Kuchling 08d87c6de1 Document addition of webbrowser.py
Mention the ANSIfication of the source.
2000-07-09 15:05:15 +00:00
Fred Drake a83b68a143 Remove the only Py_PROTO in the docs. 2000-07-09 03:35:10 +00:00
Fred Drake 146b28086f Minor revisions similar to some information in the new docstrings. 2000-07-08 16:59:03 +00:00
Andrew M. Kuchling 35e8afb76e Rearrange order of sections
Fix some incorrect module names
2000-07-08 12:06:31 +00:00
Fred Drake 5443c49fbb Markup improvements in sections relating to interactive behavior.
Clarify some of the details of readline-related configuration.
2000-07-08 05:18:54 +00:00
Fred Drake c826ecbf8f Add an entry for the KDE File Manager support from Peter Funk. 2000-07-07 17:08:40 +00:00
Marc-André Lemburg 4707320566 Added new APIs and fixed some other Unicode ones (missing * or
extra ' ').
2000-07-07 15:48:54 +00:00
Marc-André Lemburg 5a20b21fb1 Added docs for the new Unicode and string APIs. 2000-07-07 15:47:06 +00:00
Fred Drake e4dbb86ab8 New module webbrowser. Easy-to-use controller objects to make using a
Web browser as a help/information browser easy across platforms.
2000-07-07 03:36:12 +00:00
Fred Drake aa7524cf1f Clean up markup to be more like recommended practice; only small changes
needed.
2000-07-06 18:37:08 +00:00
Fred Drake 29fa30ea6b Correct a markup nit that caused a space to be dropped from the HTML
version (actually a LaTeX2HTML bug), and clarified a sentence in the
mktime() description based entirely on comments from Grant Griffin
<grant.griffin@honeywell.com>.
2000-07-06 18:09:02 +00:00
Fred Drake e1a85f5e4a Minor changes. Explain that for class exceptions, use excdesc but do not
document the constructor parameters.  Need a better way, but this will do
for now.
2000-07-06 16:12:47 +00:00
Skip Montanaro 8968a8292f modified template to demonstrate subsection for examples. 2000-07-06 13:43:37 +00:00
Fred Drake 5802e48033 Added some further description to the usage of the seealso environment.
Documented the \seerfc and \seeurl macros used in that environment as well.
2000-07-06 05:24:41 +00:00
Fred Drake 3c62d9e656 Several small changes, mostly to the markup, to improve consistency and
internal hyperlinking.  Move some things around, also for consistency
with other modules ("See also" stuff tends to live at the \section level,
before sub-sections, etc.).
2000-07-06 04:51:04 +00:00
Fred Drake 14ea85f325 Add entry for readline documentation. 2000-07-06 04:47:25 +00:00
Fred Drake 011028cf74 Sjoerd Mullender <sjoerd@oratrix.nl>:
Updates for recent changes in xmllib.
2000-07-06 04:45:14 +00:00
Fred Drake d14423abe2 Correct typo in description of the machine name parameter to the
ConnectRegistry() function; there is no trailing period!
2000-07-06 04:38:37 +00:00
Skip Montanaro 63099f911f added seealso pointing reader at readline example which uses atexit. 2000-07-06 03:26:39 +00:00
Skip Montanaro 510ca1d338 simple-minded readline section doc based upon module's doc strings. 2000-07-06 03:25:26 +00:00
Fred Drake 191a28218f Typo: "This table table" -> "This table is"
Noted by Nicholas Spies <ns11@voicenet.com>.
2000-07-06 00:50:42 +00:00
Skip Montanaro 0915165096 added warning about incompatibility with other codes' use of sys.exitfunc. 2000-07-05 23:11:26 +00:00
Fred Drake b5316188ee Created a new chapter on structured markup processing, including the
existing SGML, HTML, & XML support, and providing a home for the new
XML support as it becomes documented.
2000-07-05 02:24:39 +00:00
Fred Drake c05cbb0527 Wrapped some long lines.
Cleaned up the table of error constants defined in pyexpat.errors; an
extra pair of braces had pretty much destroyed the table!  (Not sure why.)
Moved the pyexpat.errors module documentation into a \section with the
proper headers for a module.
2000-07-05 02:03:34 +00:00
Fred Drake 25e7cee1c8 get_starttag_text(): Document this method. 2000-07-03 14:32:04 +00:00
Fred Drake ae96aab1fe Marc-Andre Lemburg <mal@lemburg.com>:
Update the API docs for the new macros Py_UNICODE_ISALPHA() and
Py_UNICODE_ISALNUM().
2000-07-03 13:38:10 +00:00
Fred Drake 52dc76c81f Eric S. Raymond <esr@thyrsus.com>:
This patch implements relative-path semantics for the "source" facility resembling
those of cpp(1), documents the change, and improves the shlex test main to
make it easier to test this feature.  Along the way, it fixes a name error
in the existing docs.

[Additional documentation markup changes for consistency by FLD.]
2000-07-03 09:56:23 +00:00
Fred Drake 353aaadd9b Moshe Zadka <moshez@math.huji.ac.il>:
Substantial updates to reflect Moshe's Gordon's enhancements to the
module.

Additional changes from Fred to reflect his changes to the module as well.
2000-07-03 08:24:49 +00:00
Fred Drake fcc95a4d04 Tim-blessed documentation for math.frexp(). 2000-07-03 06:38:17 +00:00
Fred Drake c3a65982a3 others --> other's (possessive)
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:47:38 +00:00
Fred Drake 506a7a87ff Send a "ARTICLE" --> Send an "ARTICLE"
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:43:19 +00:00
Andrew M. Kuchling 791b366f8f Added more changes from /F 2000-07-01 15:04:18 +00:00
Andrew M. Kuchling fed4f1e9c5 Changes from Moshe:
- distutils: Windows installers are already working

- string methods: .join() seems to be the concensus, so it should probably
  be docommented

- filecmp.py supersedes cmp, cmpcache and dircmp

- winreg is completely new: _winreg is an adaptation of what used to be in
  win32api, and winreg is a Python implementation which adds OO syntax.
  Perhaps you know that, but the text is misleading.
2000-07-01 12:33:43 +00:00
Fred Drake d95f4e1a0d Martin von Loewis <loewis@informatik.hu-berlin.de>:
Correct typo that caused a well-formedness failure.
2000-07-01 06:26:44 +00:00
Fred Drake b906d2ee66 Do not build the "longhtml" version for pre-release versions. 2000-07-01 02:37:37 +00:00
Fred Drake 1cd3c14034 The new copyright / license. 2000-07-01 01:41:55 +00:00
Andrew M. Kuchling a6161edf02 Refer to "Authors", plural 2000-07-01 00:23:02 +00:00
Andrew M. Kuchling 8357c4c9c6 Update the version number in an example 2000-07-01 00:14:43 +00:00
Andrew M. Kuchling 70ba382788 Updated the URL for Python 2.0 2000-07-01 00:13:30 +00:00
Guido van Rossum fd71b9e9d4 Change copyright notice. 2000-06-30 23:50:40 +00:00
Fred Drake f857ac97e9 Ignore the generated api.tex. 2000-06-30 19:25:41 +00:00
Fred Drake 1739be50cb Small grammatical correction from Frank Stajano. Added comment with
suggestion from Frank for an example and further explanation.
2000-06-30 17:58:34 +00:00
Fred Drake 46346ec14e Try to make sure \code always uses roman (non-italic) text.
Change a 1.6 version number used in a an example in a comment to 2.0.
2000-06-30 17:57:05 +00:00
Fred Drake 30f76ffd00 Update version numbering from 1.6 to 2.0. 2000-06-30 16:06:19 +00:00
Fred Drake 633a8d90d5 Update authors email address and corporate affiliation. 2000-06-30 15:54:18 +00:00
Fred Drake e06f0f9a13 Uncomment some additions from Vladimir pertinent to 2.0 but not 1.5.2. 2000-06-30 15:52:39 +00:00
Fred Drake aad1d4b8f2 Update the release number & date, Guido's employer. 2000-06-30 15:35:16 +00:00
Fred Drake f0e88980f3 Document randrange(). 2000-06-30 15:32:31 +00:00
Fred Drake 2e7cbc2cda Fix an icon width; a "32" became a "3" somehow, and that did not look
as nice. ;)
2000-06-30 15:30:33 +00:00
Andrew M. Kuchling 62cdd96acb Credit /F in a few places
Mention the GC module
Add MH's explanation of the Windows crash
Add atexit.py
2000-06-30 12:46:41 +00:00
Fred Drake 57a2f7f8ef Change description of altzone to not refer to the "0th meridian". 2000-06-30 04:24:52 +00:00
Fred Drake 9a748aa832 Say "manual page", not "man page", when referring to the Unix manual. 2000-06-30 04:21:41 +00:00
Fred Drake abbc7344a4 Make sure to note that this module was added for Python 2.0! 2000-06-30 03:50:06 +00:00
Fred Drake 6e71cdd9f1 Reflect the name change to _winreg; we still need documentation for the
new winreg module.
2000-06-30 03:45:40 +00:00
Fred Drake 01df453f16 Update Python version numbers from 1.6 to 2.0 where appropriate.
Make some references between the distutils documents hyperlinks using
the \citetitle markup.
2000-06-30 03:36:41 +00:00
Andrew M. Kuchling 730067effc Finished the GC section.
Removed all but one XXX.
Replaced 1.6 with 2.0.
Various minor corrections and additions.
2000-06-30 01:44:05 +00:00
Andrew M. Kuchling efc43d4478 Document recently-added mouse-related functions 2000-06-30 01:05:39 +00:00
Fred Drake cc7371c437 Removed --l2h-config option; it introduced unnecessary complexity and
is not needed anywhere.
2000-06-29 23:01:40 +00:00
Fred Drake d04038d9d2 Update comments relating to the removal of the -X option and of string
exceptions in the interpreter and standard library.
2000-06-29 20:15:14 +00:00
Fred Drake 8aa3bd9098 Make it clear that id() can return either a long integer or a plain integer. 2000-06-29 03:46:46 +00:00
Fred Drake 0f353ed90d Add update of httplib docs to reflect Greg Stein's recent updates.
Greg, this is yours!
2000-06-29 03:33:28 +00:00
Fred Drake ab43fcad5f Give Moshe some work to do. 2000-06-28 22:13:06 +00:00
Fred Drake 5c529d3f3e Add a "See also:" link to the curses.ascii module. 2000-06-28 22:11:40 +00:00
Fred Drake 589f44b9d0 Made the title of the Examples subsection plural! 2000-06-28 22:09:20 +00:00
Fred Drake be93a8332e Added note that the atexit module was added for Python 1.6. 2000-06-28 22:07:55 +00:00
Fred Drake 6f2a5efec9 Added entry for the curses.ascii module. 2000-06-28 22:05:44 +00:00
Fred Drake 5ccd4b2a54 Added entries for the curses.ascii module. 2000-06-28 22:03:29 +00:00
Fred Drake 4e716fa0ac Skip Montanaro <skip@mojam.com>:
Added an example of using an HTTP POST request.
2000-06-28 21:51:43 +00:00
Fred Drake 7388f730a3 Support constant as a font name for the first column of a table using the
tableii & friends markup family.
2000-06-28 21:06:08 +00:00
Fred Drake 35c09f2e51 Revise the description of when functions retrieved from class instances
are and are not turned into bound methods; some confusion was noted by
Andrew Dalke.

In particular, it has to be noted that functions located on the class
instance are not turned into any sort of method, only those which are
found via the underlying class.
2000-06-28 20:15:47 +00:00
Fred Drake c82634c13c Thomas Wouters <thomas@xs4all.net>:
Documentation updates related to the addition of openpty() and forkpty().
2000-06-28 17:27:48 +00:00
Fred Drake ec105d0993 Enhanced memory-reference information in the description of Py_BuildValue(),
based on response from Frank Stajano <fstajano@uk.research.att.com>.
2000-06-28 16:15:08 +00:00
Fred Drake cabbc3be5b Added documentation for PyOS_AfterFork(). 2000-06-28 15:53:13 +00:00
Fred Drake 2b9e180ec3 Added memory-reference information to the description of Py_BuildValue(),
based on comments from Frank Stajano <fstajano@uk.research.att.com>.
2000-06-28 15:32:29 +00:00
Fred Drake c19425d520 Added the atexit module and documentation from Skip Montanaro
<skip@mojam.com>.  Revisions to the markup to make it pass LaTeX, added
an index entry and a reference from the sys.exitfunc documentation.

This closes SourceForge patch #100620.
2000-06-28 15:07:31 +00:00
Andrew M. Kuchling 69db0e4a0b Added section on cycle GC
Various minor fixes
2000-06-28 02:16:00 +00:00
Andrew M. Kuchling af5b76677f Changed obsolete e-mail alias 2000-06-27 03:16:04 +00:00
Andrew M. Kuchling f57d7b9e30 Dcoumentation for ascii.py. I've changed two references from ascii to
curses.ascii.
2000-06-26 23:59:24 +00:00
Andrew M. Kuchling 662d76ee7b Fix typos and errors noticed by Skip Montanaro 2000-06-25 14:32:48 +00:00
Greg Ward 1bbe32982d Minor wording tweaks.
Kludged the extra-wide table that summarizes the manifest template language
  (works with LaTeX, but is an *evil* kludge and could well break LaTeX2HTML
  or similar...).
2000-06-25 03:14:13 +00:00
Greg Ward 370248d705 Some clarifications to the 'A simple example' section. 2000-06-24 01:45:47 +00:00
Greg Ward 19c67f83ad Fixed a grab-bag of typos spotted by Detlef Lannert. 2000-06-24 01:33:16 +00:00
Andrew M. Kuchling a4ca07cc8c Minor grammatical fix 2000-06-21 01:48:46 +00:00
Andrew M. Kuchling d24ff44f06 Document .timeout() method and .typeahead() function 2000-06-21 01:42:51 +00:00
Fred Drake 1d15869534 Markup consistency nits. 2000-06-18 05:21:21 +00:00
Andrew M. Kuchling 0adfb45b9a Make changes and clarifications suggested by Mark Hammond 2000-06-18 04:17:38 +00:00
Andrew M. Kuchling b8050697b8 Documentation for the mmap module: proofreaders welcomed 2000-06-17 22:39:05 +00:00
Fred Drake 992fe5a83e Updates from Marc-Andre Lemburg <mal@leburg.com> for the Unicode support. 2000-06-16 21:04:15 +00:00
Fred Drake 1c2d06acaf Added reference count information for PySequence_List(). 2000-06-16 20:00:04 +00:00
Fred Drake a8455abcf8 Documented PySequence_List() and PySequence_Tuple().
Added a bit more documentation in the chapter on building extension types,
including Py_FindMethod() documentation.

Several minor consistency nits were fixed.
2000-06-16 19:58:42 +00:00
Fred Drake c3fd45fe80 do_cmd_textasciitilde(): New function. 2000-06-15 22:41:48 +00:00
Fred Drake e57a11441e Fix markup error that hid a tilde character; reported long ago by
Carl Feynman <carlf@abinitio.com>.
2000-06-15 20:07:25 +00:00
Fred Drake 9e759dfc31 Michael Hudson <mwh21@cam.ac.uk>:
This patch corrects a little glitch and two outright errors.

(Including one reported earlier by Thomas Wouters.)
2000-06-15 18:44:30 +00:00
Fred Drake fb79ffae4d Hook in the documentation for the unicodedata module. 2000-06-13 20:51:29 +00:00
Fred Drake 28b294459d Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for the unicodedata module (massaged by Fred for minor
consistency issues).
2000-06-13 20:50:50 +00:00
Andrew M. Kuchling 6b14eebae6 Documentation for the pyexpat module. 2000-06-11 02:42:07 +00:00
Andrew M. Kuchling c0328f014b Mention setting the default encoding
Add IDLE section from MZ
2000-06-10 15:11:20 +00:00
Andrew M. Kuchling a5bbb0089a List more deleted modules.
Add request for feedback.
2000-06-10 02:41:46 +00:00
Andrew M. Kuchling 6c3cd8dd6a Filled in the sections on new and deleted modules.
Bumped version number.
2000-06-10 02:24:31 +00:00
Andrew M. Kuchling 7f6270d97e Minor fixes, additions to notes 2000-06-09 02:48:18 +00:00
Fred Drake d1a65ff40b Added preliminary documentation for the winreg module,
by Mark Hammond <markh@activestate.com>.

Limited markup & consistency revisions by FLD.
2000-06-07 04:07:48 +00:00
Andrew M. Kuchling b853ea0541 Latex formatting fixes 2000-06-03 03:06:58 +00:00
Andrew M. Kuchling fa33a4e494 Patches from Moshe, w/ AMK's revisions
Wrote Unicode section
2000-06-03 02:52:40 +00:00
Andrew M. Kuchling 5b8311e3c1 Filled out the "Core Changes" section. 2000-05-31 03:28:42 +00:00
Fred Drake 6c16019136 Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code. 2000-05-30 14:39:45 +00:00
Greg Ward 3e7b133c95 Added concrete example of when separate build and install might be
useful (suggested by Moshe Zadka).
2000-05-30 03:00:43 +00:00
Andrew M. Kuchling 25bfd0e8d0 Article about 1.6 new features 2000-05-27 11:28:26 +00:00
Fred Drake b80a777859 Added documentation for gettempprefix().
Deprecated direct access to template.
Added note about past need to modify template so that legacy code has a
better chance of being understood, noting that the requirement to reset
template after os.fork() disappeared in 1.5.2.
2000-05-26 19:32:14 +00:00
Fred Drake 0233075fce Added documentation for TemporaryFile() and the siffix parameter to mktemp().
Removed obsolete comments about this module not creating or removing actual
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().
2000-05-26 19:05:16 +00:00
Fred Drake 99d707af47 Piers Lauder <piers@cs.su.oz.au>:
I've added an extra comment about quoting arguments to
IMAP4 commands. Also changed the command descriptions
to show optional extra commands where appropriate.

Fred Drake:
Added example usage for the search() method based on comments from
<Lucas.DeJonge@awtpl.com.au>; elaborated error handling information
when arguments are missing from search() and uid().
2000-05-26 04:08:37 +00:00
Greg Ward 6153fa19ce Guido's rewording of my definition of "root package", with an addition by me. 2000-05-26 02:24:28 +00:00
Greg Ward 59d382e482 A grab-bag of wording tweakage. 2000-05-26 01:04:47 +00:00
Guido van Rossum 51060be2f8 Remove unused "import curses". 2000-05-24 14:33:26 +00:00
Andrew M. Kuchling f1dc5fa2c8 Updated docs to list all the new methods and functions. The docs are
now complete, but probably still not very helpful or friendly.

Note: two very large tables (of key names, and of character names) were
added; these tables format terribly, and need some reworking.
2000-05-23 16:46:04 +00:00
Fred Drake 7cb42cd070 From Greg Ward <gward@python.net>:
Typo:  "dictionairy" --> "dictionary" (twice).
2000-05-23 02:28:26 +00:00
Fred Drake 8c5cedee69 New description for math.frexp() -- poor description noted by
Francois Pinard.
2000-05-18 05:07:38 +00:00
Gregory P. Smith 147e5f3c65 Doc patch from Bastein Kleineidam: start to describe the 'install' command
family, including the new 'install_scripts' and 'install_data' commands.
2000-05-12 00:58:18 +00:00
Guido van Rossum c9a5f343bc The addition of rint() (by Peter Schneider-Kamp; I forgot to mention
that before) in the previous patch has one problem; rint() is not in
the C math library on all platforms (e.g. not for VC++).  Make it
conditional on HAVE_RINT.
2000-05-11 18:42:27 +00:00
Guido van Rossum 71260b846e Added math.rint() -- round according to current IEEE754 mode 2000-05-11 18:19:42 +00:00
Fred Drake 65e69002a2 Oops, better also note that the module initialization function must be
extern "C" for C++.
2000-05-10 20:36:34 +00:00
Fred Drake 2d54523551 Section "The Module's Method Table and Initialization Function":
Explain that the name of the initialization function must be
        init<module>().  Omission noted by Daniel Kozan
        <crum@dev-group.com>.
2000-05-10 20:33:18 +00:00
Fred Drake 625d70a7a6 Fix references to the built-in compile() that don't include the
filename parameter.  Noted by Randall Hopper <aa8vb@yahoo.com>.
2000-05-09 17:10:23 +00:00
Fred Drake 35784dff6a Skip Montanaro <skip@mojam.com>:
The intent is that this diff adds a link to the rfc822 module doc and
an index reference to this module under the rfc822 heading.

Fred, based on a suggestion from Grant Griffin <grant.griffin@honeywell.com>:
Added link to the MIME FAQ, so people can more easily get more
information about the subject of the module.
2000-05-09 16:23:23 +00:00
Fred Drake 51313f164c Define \seeurl in the seealso environment. Two parameters: url, why. 2000-05-09 16:18:44 +00:00
Fred Drake ef4d111b2a do_cmd_seeurl(): New function. 2000-05-09 16:17:51 +00:00
Fred Drake d85f05940e read() method: clarify that strings are accepted and interpreted
reasonably.

readfp() method:  added documentation.
2000-05-09 15:06:32 +00:00
Fred Drake 3d69c0e440 Someone found the examples of poor practice on socket addresses!
Spotted by Greg Kochanski <gpk@bell-labs.com>.
2000-05-03 19:40:32 +00:00
Fred Drake 25871c001f Brian Hooper <brian_takashi@hotmail.com>:
Added 'u' and 'u#' tags for PyArg_ParseTuple - these turn a
PyUnicodeObject argument into a Py_UNICODE * buffer, or a Py_UNICODE *
buffer plus a length with the '#'.  Also added an analog to 'U'
for Py_BuildValue.
2000-05-03 15:17:02 +00:00
Fred Drake ae08853fb0 Clarify status of connection of a new instance; it *is* connected if
you pass server information to the constructor.  Error noted by Pedro
Diaz Jimenez <diazjimenez@ctv.es>.
2000-05-03 15:11:47 +00:00
Fred Drake c26cc91c0c Added descriptions of \versionadded and \versionchanged. 2000-05-02 17:43:44 +00:00
Fred Drake 52e7684af1 do_cmd_versionchanged():
Added support for optional parameter explaining the change
        that was made in the specified version.
2000-05-02 17:37:42 +00:00
Fred Drake e06d025e00 Use \versionchanged to indicate when the second parameter to utime()
was allowed to be None.
2000-05-02 17:29:35 +00:00
Fred Drake a6e8339e61 \versionchanged: Added optional parameter for explanation of change. 2000-05-02 17:28:36 +00:00
Guido van Rossum d67ddbbec1 Eric Raymond:
(1) Added and documented the capability for shlex to handle
lexical-level inclusion and a stack of input sources.  Also, the input
stream member is now documented, and the constructor takes an optional
source-filename.  The class provides facilities to generate error
messages that track file and line number.

(2) Add a convenience function to generate C-compiler style error
leaders.
2000-05-01 20:14:47 +00:00
Barry Warsaw 93a8eacde5 Document the new additional signature for utime(). In addition to the
previous functionality utime(path, (atime, mtime)), now allowed is
utime(path, None) which sets the file's times to the current time.
2000-05-01 16:18:22 +00:00
Fred Drake 40ee7acb95 \file and \filenq should not be used in section titles; they are not
sufficiently robust to survive the creation of bookmarks in the PDF
format.
2000-04-28 18:17:23 +00:00
Fred Drake 20bab56118 Don't worry about the output dirs for the distutils manuals. 2000-04-28 17:45:27 +00:00
Fred Drake 8187cb9664 Added distutils manuals.
Made the attributes more XHTML-friendly.
2000-04-28 17:43:12 +00:00
Greg Ward e78298a6bd Stripped leading 'sec:' from all section labels -- generates bad filenames,
bad link URLs in HTML, etc.
2000-04-28 17:12:24 +00:00
Greg Ward e9792c4563 When building HTML releases, refer to */*.css and */*.html instead of
???/*.css and ???/*.html -- need to pick up the Distutils manuals!
2000-04-28 17:09:17 +00:00
Greg Ward 3abb104356 Added the Distutils manuals. 2000-04-28 17:05:41 +00:00
Greg Ward 0784c335f3 Added the Distutils manuals: inst and dist. 2000-04-28 17:03:26 +00:00
Greg Ward 0862f800d0 Added 'inst' and 'dist' -- the two Distutils manuals. 2000-04-28 16:53:36 +00:00
Fred Drake 3c3507fd4f Documentation patch describing the 'u' and 'u#' format specifiers,
from Brian Hooper <brian_takashi@hotmail.com>.
2000-04-28 14:43:33 +00:00
Fred Drake 638ae9d0bb Support for the special macros used by the distutils documentation. 2000-04-27 21:27:49 +00:00
Greg Ward 38c28e379c Added a note to the section on 'exec' about the need for a trailing newline
in certain circumstances.  (Apparently, this is a CPython problem.)
2000-04-27 18:32:02 +00:00
Fred Drake ac308d0a6f Added a "See also:" section that exhibits the \seerfc markup. 2000-04-26 18:20:04 +00:00
Fred Drake 64b72b6f4f Define \seerfc within the seealso environment. 2000-04-26 18:13:58 +00:00
Fred Drake 37cc0c0e9f ref_module_index_helper(): Use "my" instead of "local".
get_rfc_url():  New function; returns the URL for a numbered IETF RFC.

do_cmd_rfc():  Use get_rfc_url() instead of hard-coding in the HTML
               formatting.

do_cmd_seerfc():  New function.

do_env_definitions():  Small change to avoid "local".
2000-04-26 18:05:24 +00:00
Fred Drake c009d198db Removed some extraneous and confusing parenthesized expressions.
Noted by Skip Montanaro <skip@mojam.com>.
2000-04-25 21:09:10 +00:00
Greg Ward 4a9e72266d Added section headers for "Extending the Distutils" section (just
a reminder to myself).
2000-04-25 02:57:36 +00:00
Greg Ward 87da1ea127 Patch from Andrew Kuchling: document the new multiple pattern feature in the
manifest template.
2000-04-21 04:35:25 +00:00
Greg Ward d5767a5e43 Reformatted wide paragraphs. 2000-04-19 22:48:09 +00:00
Greg Ward 4eaa3bfed0 Reverted '\var' in the "standard installation location" table to '\filevar'.
Reformatted wide paragraphs.
2000-04-19 22:44:25 +00:00
Greg Ward c402fa122f Dropped '\tilde' and '\bslash' definitions. 2000-04-19 22:40:34 +00:00
Greg Ward 4756e5fb1c Changed '\tilde' and '\bslash' to the standard '\textasciitilde' and
'\textbackslash'.
2000-04-19 22:40:12 +00:00
Greg Ward 95da443447 Removed '\package' definition. 2000-04-19 22:36:33 +00:00
Greg Ward 1ecc251538 Changed '\package' to \module'. 2000-04-19 22:36:24 +00:00
Greg Ward a021acacfb Changed '\option' to '\longprogramopt' wherever it referred to a command-line
option.
2000-04-19 22:34:11 +00:00
Fred Drake cebda6f5f0 Added documentation for WindowsError; omission noted by Michal Bozon
<bozon@natur.cuni.cz>.

(Mark Hammond, other Python/Windows cognoscenti: please check this!)
2000-04-17 17:42:00 +00:00
Fred Drake e99d1dbc74 Clarify the description of the else clause for try/except, and add an
explanation of why you'd want to use it.

Based on a question from Michael Simcich <msimcich@accesstools.com>.
2000-04-17 14:56:31 +00:00
Greg Ward 46b98e35fd Various wording/formattin tweaks.
Started spewing "Creating Built Distributions" section.
2000-04-14 01:53:36 +00:00
Fred Drake 9cf7587fdc Update change to version_info structure. 2000-04-13 17:51:58 +00:00
Fred Drake 4d65d73686 Document hexversion (incompletely explained) and version_info (easily
explained).
2000-04-13 16:54:17 +00:00
Greg Ward 502d2b4615 Added note about usual default prefix under Linux (thanks to Peter Funk
for the idea).
2000-04-12 14:20:15 +00:00
Greg Ward 822a86a955 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Still some not-quite-standard definitions in here that I have to fix.
2000-04-12 01:44:35 +00:00
Greg Ward d5faa7ea08 Changed the table of per-platform default installation locations to be
more consistent with the rest of the Python docs.
2000-04-12 01:42:19 +00:00
Fred Drake ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +00:00
Fred Drake 2b85341776 Elaborate descriptions of \e, \module.
Describe policy on vertical lines in tables.
2000-04-11 19:08:30 +00:00
Fred Drake ce44498ba8 Revise the description of \programopt, document \longprogramopt. 2000-04-11 18:52:52 +00:00
Fred Drake 493624941a \longprogramopt: New macro. 2000-04-11 18:47:59 +00:00
Fred Drake 0cd6021339 do_cmd_longprogramopt(): New function. 2000-04-11 18:46:59 +00:00
Greg Ward 08c68fc82d LaTeX macros for the Distutils manuals.
Perhaps these should be added to the standard Python style file?
2000-04-11 02:01:52 +00:00
Greg Ward c392caa390 Spewed a bunch more verbiage.
Lots of scattered wording changes.
2000-04-11 02:00:26 +00:00
Fred Drake 8520cc2328 Added reference count information for Py_FindMethod(). 2000-04-10 19:38:24 +00:00
Fred Drake 7357770153 Yet another markup nit: functions that are part of the Python/C API
are still C functions, and should be marked.
2000-04-10 18:50:14 +00:00
Fred Drake 37f41565a8 PyErr_Format():
Remove statement that the return value is always NULL; this is
        generated by the formatting.
2000-04-10 18:46:22 +00:00
Jeremy Hylton 98605b54b4 document PyErr_Format 2000-04-10 18:40:57 +00:00
Fred Drake 0682be4524 letters:
Fix description; lowercase and uppercase are strings, not
        functions!  Noted by Randall Hopper <aa8vb@yahoo.com>.

maketrans():
        Minor markup nits in description.
2000-04-10 18:35:49 +00:00
Fred Drake 8394595f3b Add to the comment a description of the "null" value for returned
PyObject* values.
2000-04-10 18:29:21 +00:00
Fred Drake c2578c5bb6 load_refcounts(),
do_env_cfuncdesc():  Support the "null" value for the refcounts field
        in refcounts.dat.
2000-04-10 18:26:45 +00:00
Fred Drake db2764d941 The reference count field for PyErr_NoMemory() and
PyErr_SetFromErrno() should be "null".
2000-04-10 18:25:09 +00:00
Fred Drake 5e872de6c7 If the refcount field is "null", that's ok; the value will be None. 2000-04-10 18:24:26 +00:00
Fred Drake 729eca1b9d For functions which return a PyObject* but use "null" for the
reference count field, state that the return value is always NULL.

(Useful for some PyErr_*() flavors.)
2000-04-10 18:23:47 +00:00
Fred Drake 0a863da1f8 cfuncdesc environment:
When processing the optional parameter, don't append any text;
        let the pre-processor supply all of it.
2000-04-10 18:21:38 +00:00
Fred Drake adb272ceee do_cmd_datalineni(): New function, to implement the non-indexing form
of \dataline.
2000-04-10 17:47:14 +00:00
Greg Ward c248baecb3 Moved definition of \XXX command out to distutils.sty. 2000-04-09 20:55:35 +00:00
Greg Ward 6002ffc38c Wrote the introduction (including several subsections).
Started writing the "Standard Build and Install" section.
2000-04-09 20:54:50 +00:00
Greg Ward facb8dbaeb Fixed so LaTeX can actually process it, and so it looks like the other
Distutils manual.
2000-04-09 04:32:40 +00:00
Greg Ward 16aafcd85b Got started for real on this manual. Completely untested and unread -- just
checking it in so I can move things around in the CVS repository.
2000-04-09 04:06:44 +00:00
Greg Ward 7593eb3267 Extracted a bunch of Distutils-specific commands and macros to distutils.sty
(also needed by inst.tex).
2000-04-09 03:59:15 +00:00
Fred Drake 9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake e7a8c972d8 Added support for the "Long HTML" version to the build/packaging
process.
2000-04-07 16:27:15 +00:00
Fred Drake c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +00:00
Fred Drake 46f14580cb Describe the purpose of the "long HTML" package. 2000-04-07 14:47:27 +00:00
Fred Drake cff5482d37 Mark RELEASE with the release level ("a2"). 2000-04-06 18:38:30 +00:00
Fred Drake 69ca950d1f Make sure the \declaremodule uses the right name for the module!
Clean up several markup problems & inconsistencies.
2000-04-06 16:09:59 +00:00
Fred Drake 343301aaa4 unichr(),
unicode():  Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
Fred Drake 0b72116812 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeType.
2000-04-06 15:05:04 +00:00
Fred Drake 56ced2a7e4 Marc-Andre Lemburg <mal@lemburg.com>:
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
Fred Drake 5828ad6963 Revised / removed comments about string exceptions (relating to the
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
Fred Drake 3cb793e8e8 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
Fred Drake 61098f201e Marc-Andre Lemburg <mal@lemburg.com>:
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
Fred Drake 665dd704a3 Note the exception raised when parameter to chr() is out of range. 2000-04-06 14:45:19 +00:00
Fred Drake 33d51841a3 Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
Fred Drake 2097ef126b Added entry for codecs module. 2000-04-06 14:26:43 +00:00
Fred Drake 98f8a3d8da Added codecs entry here as part of String Services. 2000-04-06 14:25:28 +00:00
Fred Drake b7979c756c Marc-Andre Lemburg <mal@lemburg.com>:
codecs module documentation, with some preliminary markup
adjustments from FLD.
2000-04-06 14:21:58 +00:00
Fred Drake 9dc30bb956 Marc-Andre Lemburg <mal@lemburg.com>:
Tutorial information about Unicode strings in Python, with some markup
adjustments from FLD.
2000-04-06 14:17:03 +00:00
Fred Drake a4cd2611f4 Marc-Andre Lemburg <mal@lemburg.com>:
API documentation for Unicode support from C.
2000-04-06 14:10:29 +00:00
Fred Drake 8b3ce9e099 But don't do the funny \UNICODE macro; we're trying to get away from
those markups!  <with-mixed-feelings>
2000-04-06 14:00:14 +00:00
Fred Drake f0aff8e759 Patch from Marc-Andre Lemburg <mal@lemburg.com>:
Added Unicode type to the language reference.
2000-04-06 13:57:21 +00:00
Fred Drake 6d5c6bdb25 Removed bogus connect() call in SMTP example; reported by Travis
B. Hartwell <slt5v@cc.usu.edu>.

Removed second copy of the "See also" section!
2000-04-05 22:12:06 +00:00
Fred Drake 71b04dab58 Added reference to the multifile module from the "See also" section
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
2000-04-05 22:05:15 +00:00
Fred Drake d1a56f4235 Noted by Guido:
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist.  Reference is now to UTC.
2000-04-05 15:06:03 +00:00
Fred Drake 898915d7e2 Noted by Guido:
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
Fred Drake 43b89b637f Noted by Guido:
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
2000-04-05 15:00:38 +00:00
Fred Drake bf4041a0a6 Merged in changes from 1.5.2p2 release. 2000-04-04 20:58:39 +00:00
Fred Drake 02ba62141e Merged in changes from 1.5.2p2 release as appropriate. 2000-04-04 20:58:25 +00:00
Fred Drake 12ed36525a Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
(re-written).
2000-04-04 20:43:50 +00:00
Fred Drake 005f494a7f Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>. 2000-04-04 20:42:38 +00:00
Fred Drake 69fbf33680 Fixed typo in example code; spotted by Everett Lipman
<lipman@sphere.niddk.nih.gov>.
2000-04-04 19:53:06 +00:00
Fred Drake 7d68690d8d Added notes about the eventual disappearance of two-parameter bind(),
connect(), and connect_ex().

I didn't make these deprecation notices since it was never a
documented feature.
2000-04-04 17:48:30 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake 659ebfa79e Merge in changes from the 1.5.2p2 release.
Hopefully I got all this right!
2000-04-03 15:42:13 +00:00
Fred Drake eb725cd045 Merged changes from the 1.5.2p2 release. 2000-04-03 15:06:40 +00:00
Fred Drake 6a0d844e76 UserString section:
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.

Make the spelling of Unicode always uppercase.
2000-04-03 15:02:35 +00:00
Fred Drake 42934689ea Note that "Unicode" is always capitalized. 2000-04-03 15:00:28 +00:00
Fred Drake 54fd8452a1 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:54:28 +00:00
Fred Drake e15956b465 Merged changes from the 1.5.2p2 release. 2000-04-03 04:51:13 +00:00
Fred Drake 20082d92f2 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:26:58 +00:00
Fred Drake ba82878a3b Merged changes from the 1.5.2p2 release. 2000-04-03 04:19:14 +00:00
Fred Drake a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake 9a257b4fd4 Added --numeric option, similar to mkhtml.sh. 2000-03-31 20:27:36 +00:00
Fred Drake 9c26f5dbed Added rule to copy in the icons/ directory. 2000-03-31 20:26:33 +00:00
Fred Drake 3bb719f744 List of subdirs that are generated during the build. 2000-03-31 20:26:00 +00:00
Fred Drake e018beea94 Build rules for the "long HTML" version. 2000-03-31 20:22:29 +00:00
Fred Drake ddc6c276b7 Improve explanation of reference counts for PyString_Concat(). 2000-03-31 18:22:38 +00:00
Fred Drake 38d062d022 Reflect the two new sections in the dependencies. 2000-03-31 18:10:17 +00:00
Fred Drake 3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +00:00
Jeremy Hylton a12c7a7620 Add PyDict_Copy() function to C API for dicts. It returns a new
dictionary that contains the same key/value pairs as p.
2000-03-30 22:27:31 +00:00
Fred Drake bdcc96c9e3 Changes from 1.5.2p2, plus fix a couple of errors noted by Hernan
Martinez Foffani <hfoffani@sofrecom.com.ar>.
2000-03-29 22:41:52 +00:00
Greg Ward 8e14f05ae6 Fix small errors in description of Mac, Windows installation schemes.
Added comment about "--help" (no value) not working.
2000-03-22 01:00:23 +00:00
Greg Ward 295765630a Third attempt at documenting an installation scheme; this one feels like
it could work--reasonably short and straightforward to document, but
flexible enough that it will be able to handle more than just modules
and extensions in the future.
2000-03-18 15:11:50 +00:00
Fred Drake dee86c644e Script to annotate api.tex with reference count information. 2000-03-15 14:57:59 +00:00
Greg Ward 169f91b808 [from 2000-02-25] Second attempt at describing an installation scheme; this is
the simplified scheme that Guido proposed.  Also already-obsolete,
and saved only for posterity.
2000-03-10 01:57:51 +00:00
Greg Ward 7c1e5f65e3 [from 2000-02-23] Description of the baroque and already-obsolete
installation scheme that Fred Drake and I cooked up.  Only saved for
posterity.
2000-03-10 01:56:58 +00:00
Fred Drake 15861b2a41 Update portability information for the spawn*() functions and related
constants.  Someone will need to fill in information on the spawn*()
functions that aren't listed.
2000-02-29 05:19:38 +00:00
Greg Ward abc52169b7 The "Distributing Python Modules" manual; currently empty (I'll get to it
Real Soon Now(TM).
2000-02-26 00:52:48 +00:00
Fred Drake 0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +00:00
Fred Drake 3c227eef91 Added dependency on libtabnanny.tex. 2000-02-23 15:44:34 +00:00
Fred Drake 155348be33 Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor
consistency changes and a note that the API may change in the future.
2000-02-23 15:44:08 +00:00
Fred Drake 89af0776cd This branch is for 1.6 & forward. 2000-02-22 18:20:03 +00:00
Fred Drake c29e41df44 Script to help locate markup that LaTeX2HTML has a problem with. 2000-02-21 17:20:16 +00:00
Fred Drake 1e862e8a37 Update the description of int() to include the radix parameter;
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
2000-02-17 17:45:52 +00:00
Guido van Rossum 8006d316bc Added docs for new crc32() function. By Jim Ahlstrom.
(Fred, please check.)
2000-02-16 21:13:37 +00:00
Barry Warsaw 41d84631ba Document the API changes to the nntplib module (exceptions become
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
2000-02-10 20:26:45 +00:00
Fred Drake 2bb43a20ce The dircmp module is now obsolete. 2000-02-03 15:27:26 +00:00
Fred Drake ecb84f8e75 Don't insert extra indentation before <title> elements. 2000-01-20 22:51:14 +00:00
Fred Drake 9093834acb Added item about specific missing entries in the C API manual. 1999-12-23 17:22:13 +00:00
Fred Drake 6a90b5e4d0 Removed a couple of items that got done(!).
Moved a couple to a new "Not worth it" section (explanations were
already there).
1999-12-21 23:02:38 +00:00
Fred Drake 76e6da38c0 Document GetoptError and label error an alias. 1999-12-21 22:50:05 +00:00
Fred Drake b9bdfc6a23 Document 1.5.2+ aspects of the NotANumber exception. (Note that this
is in the development branch, not the maintenance branch!)
1999-12-21 18:45:16 +00:00
Fred Drake 89ab163479 Document that the |mode| parameter to open() is optional and explain how
the default value is determined.
1999-12-21 18:31:30 +00:00
Fred Drake 88f6ca2ce9 Document getgroups(), getlogin(), fpathconf(), pathconf(),
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00
Fred Drake d16b5abc07 Markup consistency nits that Guido didn't check. ;-) 1999-12-13 23:34:42 +00:00
Guido van Rossum 5f7a28cdf8 Doc update from Piers Lauder see changes for imaplib.py version 2.16. 1999-12-13 23:29:39 +00:00
Fred Drake 18f7a45324 Document the new stuff in the os module. 1999-12-09 22:11:43 +00:00
Fred Drake d4d4ba3fd2 Update link to PythonWare library page. 1999-12-01 18:44:09 +00:00
Fred Drake 645af9fedd rewrite_descriptor(): Fixup conversion of arguments (simpler).
join_adjacent_elements():  Hack to merge adjacent instances of
        <option>; the source \programopt with GNU-style long options
        created problems with LaTeX2HTML; this removes the evil
        workaround, which should never be necessary from structured
        documents(!).
1999-11-23 21:52:03 +00:00
Fred Drake 8a3b4495df Don't rename \var to <varname>; DocBook is too verbose here.
Do adopt DocBook's <command>, <option>, <envar> names for \program,
\programopt, \envvar.

Add \filenq --> <filename quote="no"> (it has to go somewhere, at
least for now).
1999-11-23 21:48:41 +00:00
Fred Drake d81b1b0ffa Set the date and version to reflect the actual status, not the last
released status.  Has to be changed just before publishing anyway.
1999-11-18 20:57:36 +00:00
Fred Drake 0d6bf0e544 When generating the top-level index to the documents, make sure some
oddball things from the LaTeX get translated to rational values.  This
is mostly to keep things from looking broken in a development tree
when they're not.
1999-11-18 20:56:29 +00:00
Fred Drake 7424242c1c Removed last XXX comment; no further action needed on this one. 1999-11-17 16:09:57 +00:00
Fred Drake 55e93964e6 Preliminary documentation for turtle module (Tk), by Moshe Zadka.
Fixed up a few TeXisms and markup nits, but otherwise unchanged.
Somewhat raw.
1999-11-15 17:03:41 +00:00
Fred Drake 2530d4e32b Added request to please not send HTML email to the newsgroup/mailing
list or to python-docs.
1999-11-12 17:20:40 +00:00
Fred Drake 29a710f2ef Document \citetitle and \programopt. 1999-11-10 22:51:18 +00:00
Fred Drake 37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +00:00
Fred Drake e15eb35fd0 Use \citetitle as appropriate. 1999-11-10 16:13:25 +00:00
Fred Drake 9fa76f1090 Use \citetitle in several places, and \programopt where appropriate. 1999-11-10 16:01:43 +00:00
Fred Drake 698d5206aa Use \citetitle in several places. 1999-11-10 15:54:57 +00:00
Fred Drake ebe0341109 Use \citetitle instead of \emph. 1999-11-09 20:11:17 +00:00
Fred Drake 356d0ceb7e Use \citetitle in one place. 1999-11-09 20:10:01 +00:00
Fred Drake 268df27c9a Use the new markup as apporpriate. 1999-11-09 19:45:59 +00:00
Fred Drake 6e9ea59a43 Use \programopt in one place. 1999-11-09 19:44:44 +00:00
Fred Drake 91f31eab1c Added citetitle and programopt.
Made var get renamed to varname (more like DocBook).
Other names should probably be changed as well; still waiting for the
DocBook book to arrive.
1999-11-09 19:33:24 +00:00
Fred Drake d290c10890 Use \programopt in one place. 1999-11-09 18:03:00 +00:00
Fred Drake 310ee61f20 Missed a couple of program options that had been marked by \code. 1999-11-09 17:31:42 +00:00
Fred Drake a24f7b759a Use \programopt in one place. 1999-11-09 17:03:45 +00:00
Fred Drake be48646cfa Use \citetitle and \programopt as appropriate. 1999-11-09 17:03:03 +00:00
Fred Drake 7b8195a209 \programopt: New macro, used to mark command-line parameters in the
text.  Looks like \program.

\citetitle:   New macro, used to mark titles of cited works (like the
              names of the Python manuals).  Accepts & discards an
              optional parameter that is only used by the HTML
              formatter.  Looks like \emph.
1999-11-09 17:02:11 +00:00
Fred Drake c9f5fe0d1c do_cmd_programopt(): New function, similar to do_cmd_program().
do_cmd_citetitle():  New function.  Extracts one optional and one
                     required parameter.  If the optional one is
                     provided, it is used a URL (or relative URL) and
                     the text of the required parameter is turned into
                     a hyperlink.
1999-11-09 16:59:42 +00:00
Fred Drake 5bd608d46e Change the suggestions pointer at the bottom of generated HTML pages. 1999-10-29 20:51:43 +00:00
Fred Drake c6d45afb1b Straighten out dependencies so changes in the texinputs/* get reflected. 1999-10-29 20:49:23 +00:00
Fred Drake 6cf186b867 pathes --> paths; typo reported by Gerry Wiener <gerry@ucar.edu>. 1999-10-29 17:51:29 +00:00
Fred Drake 5a3194688d Added dependency on filecmp section, removed dependencies on cmp and
cmpcache sections.
1999-10-29 17:27:08 +00:00
Fred Drake 47a27b6640 Make references to new filecmp module hyperlinks now that there's
documentation.
1999-10-29 17:25:59 +00:00
Fred Drake adf2dbfced Added section for filecmp. 1999-10-29 17:24:12 +00:00
Fred Drake c7b5b3c998 filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>. 1999-10-29 17:23:15 +00:00
Fred Drake 7eaf6828cb Added deprecation notes, in case anyone decides to read these anyway. 1999-10-26 16:31:51 +00:00
Fred Drake 143db4b041 cmp and cmpcache are now obsolete, so don't include their
documentation sections.
1999-10-26 16:28:04 +00:00
Fred Drake a8052a3113 Added cmp and cmpcache to the "Obsolete" section. 1999-10-26 16:27:28 +00:00
Fred Drake 714fd26a2f Documented Beep() function. 1999-10-22 21:08:56 +00:00
Fred Drake d6512808f0 Module/script to parse the reference count data file and make the
information accessible to Python.

When run as a script, just dumps the information back out in the data
format, with functions in sorted order and a blank line between
different functions.

Still need to apply the information somehow.
1999-10-20 21:50:31 +00:00
Fred Drake 805bf1b330 Added note that Skip created the initial version of this file.
Fixed up a few of his ??? comments.
1999-10-20 16:03:38 +00:00
Fred Drake 7b7dc6b49d Initial version as provided by Skip Montanaro <skip@mojam.com>. 1999-10-20 15:06:24 +00:00
Fred Drake 39d4a0237a Fixed typo in explanation of abspath(); noticed by Paul Prescod
<paul@prescod.net>.
1999-10-18 14:10:06 +00:00
Fred Drake 532998e00d "make clobber" should remove modindex.html as well.
Added realclean and distclean as synonyms for clobber.
1999-09-24 13:51:19 +00:00
Fred Drake 88c786dad9 icons/ should not be ignored here now that this is it's real home. 1999-09-24 13:48:38 +00:00
Fred Drake cf1b06ec47 Added --about option to specify the file to load "About this
document..." text from, defaulting to ../html/about.dat.
1999-09-23 16:55:09 +00:00
Fred Drake 8903be62a8 Tell mkhowto to use stdabout.dat for the documents it processes here. 1999-09-23 16:54:06 +00:00
Fred Drake b35f2b7ef8 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.

Use a variable for the name of the file to get "About this
document..." text from.
1999-09-23 16:53:09 +00:00
Fred Drake f62b352a5e Remove the "Comments and Questions" section, allowing this to be used
for non-standard Python documentation.
1999-09-23 16:48:54 +00:00
Fred Drake b9bd0b7c82 Version of about.dat that should only be used for the standard
documentation.
1999-09-23 16:48:05 +00:00
Fred Drake d37cecfda4 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.
1999-09-23 16:45:08 +00:00
Fred Drake f42d7a78fc Oops, missed this one! 1999-09-23 15:38:14 +00:00
Fred Drake d3d28d39f8 img_tag(): Tighten up the generated SRC attribute a bit; if the image
relative URL starts with "./", remove "./".
1999-09-23 15:29:45 +00:00
Fred Drake d52879ccdc do_cmd_rfc(): Simplify the generated markup. 1999-09-22 19:58:51 +00:00
Fred Drake 52ea0ce977 Added --image-type option to allow use of either GIF or PNG images.
Job.warning():  New method; use this instead of writing to sys.stderr
                directly.  Ensures warnings are also sent to the log
                file.

Job.log():  New method; write a message to the log file.  Use from
            .message() and .warning().
1999-09-22 19:55:35 +00:00
Fred Drake 191439ab6b Some updates to allow ../tools/mkhowto to add various bits to the
supplemental l2h initialization file it creates and still get all the
right behavior.  In particular, it can change the image type and icon
location and not get inconsistent results.

Some code to help suppress various navigational pages; this might be
interesting when generating HTML to create HTML Help documents, since
the navigation support creates confusing hits in the full text
search.  HTML Help also provides a lot of the navigational
infrastructure, so duplicating it makes it more tedious to use.
1999-09-22 19:50:51 +00:00
Fred Drake 3e1a98a336 PNG version of the icons, converted from the GIFs
by Michael Hudson <mwh21@cam.ac.uk>.
1999-09-22 14:38:25 +00:00
Fred Drake 0297719180 Added section about where to send comments, questions, & bug reports. 1999-09-21 15:45:06 +00:00
Fred Drake 933d5a7c6e os.name: Note that 'java' is one of the registered names. 1999-09-17 14:38:39 +00:00
Fred Drake e6fb1c4bd3 Added documentation for inet_aton() and inet_ntoa(), from Ben
Gertzfield <che@debian.org> (with minor changes).

(Should have been here instead of in the branch in the first place,
since these weren't in for the 1.5.2 release.)
1999-09-16 15:50:00 +00:00
Fred Drake 0ba58158c5 Added "import string" to a couple of examples that describe string
module functions, to clarify that the import is not automatic.
Suggested by Koray Oner <Koray.Oner@Eng.Sun.COM>.
1999-09-14 18:00:49 +00:00
Fred Drake 244ad3ca15 Name the parameter to expr() and suite() "source" instead of "string". 1999-09-09 14:16:36 +00:00
Fred Drake 8779f648d2 Added descriptions of the t#, w, and w# PyArg_ParseTuple() format
characters; these are the ones for the buffer interface.
1999-08-27 15:28:15 +00:00
Fred Drake 0ee4891c82 Update the instructions slightly.
Add a new section describing what each of the tools does, in general
terms.
1999-08-26 18:08:13 +00:00
Fred Drake 4f0279f439 Removed; no longer needed now that the other tools can handle entity
references directly.
1999-08-26 18:05:23 +00:00
Fred Drake abb158f56b feed(): Added support for ESIS '&' lines. 1999-08-26 18:04:32 +00:00
Fred Drake 1f33292542 Remove use of fixgenents.sh; no longer needed. 1999-08-26 17:57:18 +00:00
Fred Drake 3cf4eb4e3d Specify: \geq --> &geq;
\leq    --> &leq;
                \LaTeX  --> LaTeX       (just text)
                \TeX    --> TeX         (just text)
1999-08-26 17:56:47 +00:00
Fred Drake f6199edcd3 Conversion.subconvert(): Added support for "entityref" parameters
(must be named in the conversion spec.).

TableParser.start_entityref():  New method.  Use to support creating
        entity references via the conversion specification.
1999-08-26 17:54:16 +00:00
Fred Drake a20581c1e5 write_esis(): Added support for ENTITY_REFERENCE nodes. 1999-08-26 17:51:56 +00:00
Fred Drake 53eae8e81b convert(): Add support for ESIS '&' lines, and make sure we don't
silently ignore unrecognized lines.
1999-08-26 17:50:26 +00:00
Guido van Rossum e7f19200e8 Doco update from Sjoerd Mullender. 1999-08-26 15:57:44 +00:00
Fred Drake 2900ff9382 Added paragraph explaining that except clauses can't be empty; that
pass can be used if needed.  By Dan Wolfe <wolfeman@apple.com>.
1999-08-24 22:14:57 +00:00
Fred Drake 4c2533fe3c Added sentence "All exceptions must have an executable block."; from
Dan Wolfe <wolfeman@apple.com>.
1999-08-24 22:14:01 +00:00
Fred Drake b68a125d64 Added additional index entries.
Minor markup nits.
1999-08-24 20:16:29 +00:00
Fred Drake 76dd228f52 whrandom should come immediately after random, not before. 1999-08-23 20:12:11 +00:00
Fred Drake c924b8d976 Clarified start parameter to Py_CompileString, documented
Py_eval_input, Py_file_input, and Py_single_input.

Problems reported by Aaron Brancotti <aaron@icona.it>.
1999-08-23 18:57:25 +00:00
Fred Drake abf8a1daa8 rewrite_descriptor(): Fix bug that dropped the first TEXT node from
<description> elements.  Add another sanity
                       check to make sure a special case only becomes
                       involved for <opcodedesc> and <opcodedescni>
                       elements.

fixup_paras_helper():  Clean up control flow.

Everywhere that checks node.nodeType==ELEMENT and node.tagName now
just check node.nodeName (nodeName is guaranteed for all node types
and will be special values that don't conflict with GIs for
non-ELEMENT nodes).  Simplifies a number of tests and improves
readability in a lot of places.
1999-08-20 14:28:29 +00:00
Fred Drake 7eba1d8bbe Tell what the result objects are (based on comment from the list). 1999-08-19 17:00:38 +00:00
Fred Drake 9ed56de752 Added item regarding random/whrandom. 1999-08-19 15:37:35 +00:00
Guido van Rossum b3fc9d148d Added disclaimer to the sleep() function. 1999-08-19 14:42:54 +00:00
Fred Drake 31e5e37196 Explain the possible range of values for the pid parameter to
waitpid().
1999-08-13 13:36:33 +00:00
Fred Drake 68921dfa31 In note mentioning [].remove()'s exception, tell what exception is
raised.  Prompted by Barry's whining.  ;-0
1999-08-09 17:05:12 +00:00
Fred Drake d3fbdfd007 Add index entries for open():
buffer size, I/O
	I/O control, buffering
	line-buffered I/O
	unbuffered I/O
1999-08-05 13:43:08 +00:00
Fred Drake 8c9fc00f8d Add index entry "I/O control, buffering" for fdopen(). 1999-08-05 13:41:31 +00:00
Fred Drake a94f6762bc Add index entry "I/O control, buffering" for makefile(). 1999-08-05 13:41:04 +00:00
Fred Drake 58c5a2a53c Started documentation on buffer objects & types. Very preliminary.
Greg Stein:  Please help with this; it's your baby!
1999-08-04 13:13:24 +00:00
Guido van Rossum 068bdb181d Change the directory tree walking example to use clearer variable
names, some suggested by Joe Ellsworth.
1999-08-03 21:52:29 +00:00
Fred Drake 46ab6dfa89 Re-write in Python for portability. About 30% slower, but who cares?! 1999-08-03 17:54:39 +00:00
Fred Drake 82ebc27357 remap_element_names(): Only used for things that the new conversion
engine in latex2esis.py can do, so discard it.

paragraph detection & markup:  Handle some of the list-like
		environments properly, picking up paragraphs inside
		list items.  (Only changed a few element-sets used for
		recognition.)

fixup_refmodindexes_chunk():  Use the right attribute to determine the
		module a <ref*modindex/> element is referring to.

convert():  Don't call remap_element_names(); it was removed.
1999-08-03 15:32:48 +00:00
Fred Drake 2f6ec9ca81 The new conversion engine supports more of the table re-writing than
the old one, so use it.
1999-08-03 15:27:37 +00:00
Guido van Rossum 32bc45f737 Removed PyMapping_Clear() -- it was wishful thinking and serves no
great purpose.
1999-08-02 20:49:37 +00:00
Fred Drake 83c0983bf6 Use the mksourcepgk script instead of mktarball.sh. 1999-08-02 20:20:14 +00:00
Fred Drake 9ff3a6a6e7 Remove obsolete version of script. 1999-08-02 20:19:42 +00:00
Fred Drake 9f2b42080a Re-implementation of mktarball.sh as a more portable Python script;
with a more descriptive name.

Allow creation of multiple archive formats with a single pass; useful
in this case since it uses a fresh export/checkout from CVS to ensure
that the tree is "clean" (no build turds, saved files, &c).  Use --all
to create all supported formats.
1999-08-02 20:19:17 +00:00
Fred Drake 080c1b5af6 bwrite(), ewrite(): Helpers for diagnostic output; essentially the
same as sys.stderr.write(), but bwrite() will make it
		bold if stderr is a tty (for visibility).

		Use these everywhere instead of accessing
		sys.stderr.write() directly.

find_all_child_elements():  Find all elements by type name that are
		immediate children of another.

cleanup_synopses():  Receive both the document and fragment objects as
		parameters; if only the document is passed, synopsis
		information is never found since it's in the fragment!

build_para():	Add a chunk of code to ensure that a newline always
		follows the </para> end-tag.  Not really important, but
		makes presentation consistent for authoring/
		maintenance.

fixup_bifuncindexes_chunk(): Use find_all_child_elements() instead of
		find_all_elements() so we don't work with too many
		levels at once; that could cause DOM exceptions with
		the <elem>.removeChild() method.
1999-08-02 14:46:15 +00:00
Fred Drake 4fbdf9779c Mostly minor changes.
Removed some obsolete commented-out code.

Merged BaseConversion into Conversion since there's only one
conversion process now.

Remove push/pop of output stream; it's no longer needed.
1999-08-02 14:35:25 +00:00
Fred Drake d158b85896 This doesn't need to do nearly as much for the new conversion, so
simplify.
1999-08-02 14:32:46 +00:00
Fred Drake 031e222499 A few small improvements to the conversion. 1999-08-02 14:32:11 +00:00
Fred Drake c71b802c47 Markup nits.
Adjust examples to use the object interface instead of the function
interface.
1999-08-02 14:30:52 +00:00
Fred Drake ce201128b0 Fixed hyperlink references to the __builtin__ and __main__ modules;
error reported by Dale Nagata <DNagata@creo.com>.
1999-08-02 14:13:09 +00:00
Fred Drake eac8abee4e Ripped out the old conversion. 1999-07-29 22:42:27 +00:00
Fred Drake 865e9ff98e Added a few more passes through the document fragment. Not actually
very interesting.
1999-07-29 22:23:19 +00:00
Fred Drake 96e4a06fa6 Massive changes.
Separate the Conversion class into a base and a subclass; the subclass
is pretty minimal but the separation is useful for....

NewConversion:  New class that implements a somewhat different
		approach to the conversion.  This uses a table of
		instances (rather than tuples) that have more
		information than the tuples used for the older
		conversion procedure.  This allows a lot more control
		over the conversion, and it seems to be pretty
		stable.

TableEntry,
Parameter:	New classes that are used to build the conversion
		specification used by NewConversion.

TableParser:	xmllib.XMLParser subclass that builds a conversion
		specification from an XML document.

load_table():	Convenience function that loads a table from a file.

main():  Added flags --new and --old; these select which conversion is
	 used.  The default is --new.

Several fixes have been made in the old conversion as well; these were
done before writing & switching to the new conversion, and should be
archived.

The next checkin of this file will discard the old conversion; is is
kept in this checkin to allow it to be retrieved if needed, and to
avoid lossing the bugfixes that have been made to it in the interim.
1999-07-29 22:22:13 +00:00
Fred Drake 2394c98c05 Minor updates. 1999-07-29 22:14:09 +00:00
Fred Drake ada2de67b3 Use the (new) buildFragment() method of the EsisBuilder rather than
implementing it all here.
1999-07-29 22:13:31 +00:00
Fred Drake f032cdbb24 Some minor cleanup. 1999-07-29 22:03:52 +00:00
Fred Drake bc2285eb60 Conversion specification, used by a new path through latex2esis.py.
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
1999-07-29 22:03:11 +00:00
Fred Drake 478a265057 Minor update. 1999-07-29 22:01:39 +00:00
Fred Drake c35367e439 Change an {\em ...} to \var{...} and a {\bf ...} to \program{...} (the
new markup makes sense in context).

These allow the SGML/XML conversion updates to work, & should not have
still been in there anyway.
1999-07-29 13:56:41 +00:00
Fred Drake 4ef3ea0cc4 Add support for bzip2 compression.
New target: distfiles, create all distribution archives, regardless of
archive format.  (Individual targets remain for each archive format.)
1999-07-27 16:30:59 +00:00
Fred Drake 5772f33b6c Add support for bzip2 using --bzip2. 1999-07-27 16:29:30 +00:00
Fred Drake b5213c3010 Ignore additional compressed formats. 1999-07-27 14:23:25 +00:00
Fred Drake 8d21243c3e Added description of optional parameter to UserDict constructor.
Omission reported by Barry Warsaw.
1999-07-26 15:45:52 +00:00
Fred Drake 7dcc69a979 Add zip archive support for html, pdf, ps, and latex archives.
"zips" target produces all possible .zip files.
1999-07-23 16:11:36 +00:00
Fred Drake 8ea15f3495 Add --zip parameter; make this able to produce .zip files as well as
.tgz files.
1999-07-23 16:09:11 +00:00
Fred Drake de5d5ce7bc Update getattr() description to document the optional third
parameter.  Thanks to Barry Warsaw for pointing out the oversight.
1999-07-22 19:21:45 +00:00
Fred Drake 06c5a8b52e Make the default target xml instead of sgml. 1999-07-22 13:57:12 +00:00
Fred Drake 7dbde51f97 Make the default target xml instead of sgml.
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
1999-07-22 13:56:51 +00:00
Fred Drake 5d48e458e4 typo: privide --> provide
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
1999-07-20 13:21:42 +00:00
Fred Drake 860e256147 Added comment clarifying that RELEASE is the documentation release
number, not the Python release.

Removed VERSION since it is not used.
1999-07-12 16:52:50 +00:00
Fred Drake 6b3fb78ca8 do_cmd_funclineni(): New function; non-indexing form of \funcline. 1999-07-12 16:50:09 +00:00
Fred Drake 6db897c52c Move chdir() and getcwd() descriptions to "Files and Directories" with
a pointer from the "Process Parameters" section.  Based on comments
from Aahz Maruch, Tim Peters, and GvR.
1999-07-12 16:49:30 +00:00
Fred Drake f930d827bb Use the same names for CLASS attributes as elsewhere. 1999-07-12 16:28:50 +00:00
Fred Drake bb7eff96d4 Updated Milan's email address. 1999-07-12 15:26:43 +00:00
Fred Drake 3a4ceb707d Several methods return tuples, not lists. 1999-07-07 14:04:38 +00:00
Fred Drake 363d67c2e6 Move some misc. comments from the example section to the main section.
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion).  Add a blank line
after the import line for clarity.
1999-07-07 13:42:56 +00:00
Fred Drake 1508970a47 dir() method description revised based on comments from Greg Stein. 1999-07-07 13:36:22 +00:00
Fred Drake 6166b871a2 Missing space; reported by Robert Kern <kernr@ncifcrf.gov>. 1999-07-06 21:00:18 +00:00
Fred Drake d5dfe984e7 Fix a number of minor problems pointed out by /F. 1999-07-06 15:50:23 +00:00
Fred Drake 0d6e6e0b39 Fixed typo reported by /F; thanks! 1999-07-06 15:43:55 +00:00
Fred Drake e72d48d5b2 Bump the release number to 1.5.2p1. 1999-07-06 14:30:04 +00:00
Fred Drake 919e74ce88 Darn! Forgot to re-target. 1999-07-02 15:27:14 +00:00
Fred Drake 5a8aaa7542 Remove one item.
Rearrange & comment on others.
1999-07-02 14:31:41 +00:00
Fred Drake 82ac24ffb0 Minor markup nit. 1999-07-02 14:29:14 +00:00
Fred Drake 0452007dcc Added entry for asyncore module. 1999-07-02 14:27:03 +00:00
Fred Drake 41796918af Fix a few markup nits, improve some index entries. 1999-07-02 14:25:37 +00:00
Fred Drake 7d80779532 New documentation from Chris Petrilli <petrilli@amber.org>. 1999-07-02 14:25:03 +00:00
Fred Drake 227020894a For spawn*(), point to the magic constants; some readers have a hard
time finding the bindings.
1999-07-02 14:01:03 +00:00
Fred Drake e4694eba0f Removed entries for several modules which have been documented.
Updated comments on several remaining modules.
1999-07-01 20:42:57 +00:00
Fred Drake 4c8d83f311 Documentation for dl module from Moshe. 1999-07-01 20:40:21 +00:00
Fred Drake 44a7a7c5d0 Added entry for dl module. 1999-07-01 20:39:59 +00:00
Fred Drake 85b5683307 Remove extraneous "contains" -- pointed out by Daniel Barclay
<danielb@digitalfocus.com>.

Added credit to Martin von Loewis for creating the module and
documentation.
1999-07-01 16:31:03 +00:00
Fred Drake 859dc53a52 Per Frank Stajano's suggestion, state explicitly that the functions
described in the sub-sections are directly available at the module
level.  He found this confusing.
1999-07-01 13:54:40 +00:00
Fred Drake b216060627 Make the reference to the os module in the module synopsis (for the
table at the front of the chapter) a hyperlink.
1999-07-01 13:53:32 +00:00
Fred Drake f1ad207f2a Made several grammatical corrections based on comments from Daniel
Barcla <danielb@digitalfocus.com>.

Also added example of what happens when a parameter is set both
positionally and by a keyword (one of Daniels suggestions related to
that paragraph).
1999-06-30 15:32:50 +00:00
Fred Drake 3d0971e33e For "Matching vs. Searching", remove comment that the section is
incomplete; I don't remember what else I thought I was going to put
in, but it looks o.k. to me know.
1999-06-29 21:21:19 +00:00
Fred Drake 9b59a303a8 Added some reminders. 1999-06-29 18:54:03 +00:00