Commit Graph

3366 Commits

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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