Commit Graph

3161 Commits

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