cpython-lru_cache-weakref: Doc/api.tex history

Fred's right -- we need PyList_SET_ITEM().

Fri, 24 Apr 1998 18:22:02 +0000

Fred's right -- we need PyList_SET_ITEM().

Convert recent additions to use new, "logical" markup.

Thu, 23 Apr 1998 14:06:01 +0000

Convert recent additions to use new, "logical" markup.

I suppose we really do need a markup guide. -sigh-

Filled in some more blanks, with the help of Drew Csillag.

Tue, 21 Apr 1998 15:30:01 +0000

Filled in some more blanks, with the help of Drew Csillag.

Some patches by Drew Csillag; plus a few of my own uncommitted changes.

Tue, 14 Apr 1998 20:21:10 +0000

Some patches by Drew Csillag; plus a few of my own uncommitted changes.

Typo: (and often severly limited) -- severely

Mon, 13 Apr 1998 00:53:42 +0000

Typo: (and often severly limited) -- severely
Typo: (but not to the tuple or list into which the item it put!) -- is put

Thanks, AMK!

In descriptions of Py_GetPrefix() and Py_GetExecPrefix(), make sure the

Sun, 12 Apr 1998 02:39:13 +0000

In descriptions of Py_GetPrefix() and Py_GetExecPrefix(), make sure the
"--" at the start of the configure options isn't collapsed to "-" when the
HTML is generated.

Don't assume that \version expands to the 3-character major.minor number; it

Thu, 09 Apr 1998 14:12:11 +0000

Don't assume that \version expands to the 3-character major.minor number; it
is the full release version name ("1.5.1beta1", for instance).

Capitalize "Python" for consistency.

Fri, 03 Apr 1998 05:02:28 +0000

Capitalize "Python" for consistency.

Markup consistency & nits.

Thu, 02 Apr 1998 06:47:24 +0000

Markup consistency & nits.

Fix typo in a C code example: KeyError is spelled PyExc_KeyError in C; the
"K" is upper case!

Some index entries.

On function signatures, always use parameter names. Make return types match
what's in the header files. When the return type is a pointer, always omit
the space between te type name and the "*"; leaving it in results in

type * func(..)

and having two spaces there just looks terrible.

Revert the index stuff to work better with LaTeX2HTML.

Tue, 17 Mar 1998 06:23:13 +0000

Revert the index stuff to work better with LaTeX2HTML.

Adjust the index inclusion for the new index support.

Mon, 09 Mar 1998 16:39:22 +0000

Adjust the index inclusion for the new index support.

Convert LaTeX support to create a new class of documents. HTML generation

Tue, 03 Mar 1998 22:02:19 +0000

Convert LaTeX support to create a new class of documents. HTML generation
now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress).

This means that doing things to change the formatting of the manuals (at the
"normal user" level, like A4 paper), can happen in just one place, rather
than in each document file.

Added \label{}s for logical addressing.

Thu, 26 Feb 1998 22:01:23 +0000

Added \label{}s for logical addressing.

PyFile_FromFile() description: make sure the closing brace for the arguments

Wed, 25 Feb 1998 15:40:22 +0000

PyFile_FromFile() description: make sure the closing brace for the arguments
comes after the arguments are complete.

Fixed typo reported by Vladimir Marangozov .

Fri, 20 Feb 1998 00:45:52 +0000

Fixed typo reported by Vladimir Marangozov .

Removed various "(New in 1.5a?!)" constructs. Other notes pertaining to

Mon, 16 Feb 1998 15:27:08 +0000

Removed various "(New in 1.5a?!)" constructs. Other notes pertaining to
versioning remain intact.

Place C typedef for Py_complex after brief description, to be more consistent

Mon, 16 Feb 1998 14:25:26 +0000

Place C typedef for Py_complex after brief description, to be more consistent
with the other example of a structure description (struct _frozen).

Added index entries for the modules referenced in the document.

Added index enties for the Python built-in functions, where appropriate.

Mon, 16 Feb 1998 06:23:20 +0000

Added index enties for the Python built-in functions, where appropriate.

Lots of nitty-gritty stuff:

Mon, 16 Feb 1998 06:15:35 +0000

Lots of nitty-gritty stuff:

Use \emph{} when referring to title of any of the Python manuals, like is
done in the other manuals.

In some places, use \emph{} or \dfn{} instead of ``...''.

Use \samp{} instead of \code{} when marking identifier prefixes.

Use logical markup wherever it made sense.

Fixed a bunch of typos.

In several places, use "---" instead of "--" to get the emdash.

Start sentences with capital letters and end them with periods, as needed.

"it's" --> "its" in many places: "it's" it *always* a contraction of "it is",
and "its" should always be used for the possessive.

"don't" --> "doesn't"

"should discards any" --> "should discard any"

In C function descriptions, use \var{} to mark parameters in the running
text instead of \code{}. This matches usage in the other manauls better,
and is more consistent with the formatting of the function signatures.
Lots of little changes to implement this.

Lots of fixups needed due to appearant heavy cut-&-paste in the orignal
document.

Mention that the exception objects may be either classes or strings,
depending on the use of -X; they were unequivocally stated to be strings
in the section "Standard Exceptions".

"mkvalue()" --> "Py_BuildValue()"

Description of PyNumber_Power() indicates that the third value is option,
but not how to indicate that it was omitted. Clarified.

Explain the behavior of PyString_FromStringAndSize() if the buffer is NULL.

Explain the Py_complex structure a little (tell what it's used for) and use
a {verbatim} environment for the structure definition itself.

Fix explanation of PyFile_SoftSpace().

Update the example version string to 1.5.

Combined the sections on defining new object types.

Remove obsolete pagenumbering / pagestyle cruft.

Fri, 13 Feb 1998 07:08:56 +0000

Remove obsolete pagenumbering / pagestyle cruft.

"ASCII" --> "\ASCII{}"

Thu, 12 Feb 1998 23:36:49 +0000

"ASCII" --> "\ASCII{}"

Reorganized a bit. No changed content.

Thu, 12 Feb 1998 21:22:28 +0000

Reorganized a bit. No changed content.

Guido, please take a look at new structure, at least the ToC.

For sections describing the "Foo Protocol", consistently use the capitalized

Thu, 12 Feb 1998 20:57:15 +0000

For sections describing the "Foo Protocol", consistently use the capitalized
"Protocol" and not "protocol".

Py_Exit(status) calls exit(status), not exit(0).

Thu, 12 Feb 1998 20:51:02 +0000

Py_Exit(status) calls exit(status), not exit(0).

Py_AtExit(): Added brief note about the constraint on cleanup functions not

Mon, 26 Jan 1998 19:16:27 +0000

Py_AtExit(): Added brief note about the constraint on cleanup functions not
calling the Python API.

Removed \mytableofcontents; just use \tableofcontents.

Tue, 13 Jan 1998 22:25:02 +0000

Removed \mytableofcontents; just use \tableofcontents.

Consistency:

Tue, 13 Jan 1998 18:51:10 +0000

Consistency:

"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"

Added openright option the the \documentclass{} for each of the manuals.

Tue, 13 Jan 1998 16:53:23 +0000

Added openright option the the \documentclass{} for each of the manuals.

Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility

Fri, 09 Jan 1998 05:36:43 +0000

Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility
mode) and take advantage of changes in myformat.sty.

Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all

Fri, 02 Jan 1998 03:24:19 +0000

Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all
gave the return type as part of the function field and used an empty return
type field. Fixed.

Function name field for PyLong_FromString() included an asterisk at the
beginning of the function name field; removed.

A whole bunch of typos fixed by Andrew Kuchling.

Tue, 30 Dec 1997 04:38:44 +0000

A whole bunch of typos fixed by Andrew Kuchling.
Added a warning about the incompleteness to the front.
Added a reminder about CObject to the back.

Several changes, e.g. restructuring of the intro to be closer to what

Tue, 25 Nov 1997 15:34:51 +0000

Several changes, e.g. restructuring of the intro to be closer to what
it ought to be. Maybe the last checkin before 1.5b1 is released.

struct _frozen:

Mon, 13 Oct 1997 18:18:33 +0000

struct _frozen:
Use spaces instead of tabs to indent structure definition; tabs don't
work in tex/latex.

PyImport_FrozenModules:
struct _freeze ==> struct _frozen

Change title to {Python/C API Reference Manual}; remove \bcode \ecode

Tue, 07 Oct 1997 14:38:54 +0000

Change title to {Python/C API Reference Manual}; remove \bcode \ecode
which appears to be out of fashion in this file.

Done with tread state descriptions. Sigh!

Mon, 06 Oct 1997 05:10:47 +0000

Done with tread state descriptions. Sigh!

Checkpoint. Added docs for the new exception handling APIs and for

Sun, 05 Oct 1997 15:27:29 +0000

Checkpoint. Added docs for the new exception handling APIs and for
the interfaces defined in import.h.

Fix some badly botched prototypes for PyRun* c.s.

Thu, 21 Aug 1997 02:28:57 +0000

Fix some badly botched prototypes for PyRun* c.s.

Consistently change Python-C API to Python/C API; added lots of new

Sun, 17 Aug 1997 18:02:23 +0000

Consistently change Python-C API to Python/C API; added lots of new
introductory text for reference counts and error handling, with good
examples.

Fixes to make it pass latex without complaints.

Fri, 15 Aug 1997 18:57:32 +0000

Fixes to make it pass latex without complaints.

Added more stuff on initialization (still rudimentary)

Thu, 14 Aug 1997 20:35:38 +0000

Added more stuff on initialization (still rudimentary)

Added new intro sections (incomplete); fixed various typos

Thu, 14 Aug 1997 20:34:33 +0000

Added new intro sections (incomplete); fixed various typos

Just another checkin for backup. Nothing substantial yet.

Thu, 22 May 1997 20:11:52 +0000

Just another checkin for backup. Nothing substantial yet.

Made a start with api.tex, the Python-C API Reference Manual.

Thu, 15 May 1997 21:43:21 +0000

Made a start with api.tex, the Python-C API Reference Manual.
Removed extref.tex (which provided the starting point).
Also removed qua.tex, which is out of date and no longer needed.