Commit Graph

3180 Commits

Author SHA1 Message Date
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