Commit Graph

2904 Commits

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