mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-05 07:43:50 +08:00
Code Issues Packages Projects Releases Wiki Activity
17,058 Commits 6 Branches 598 Tags 2.9 GiB
9b5abcd48c
Commit Graph

125 Commits

Author SHA1 Message Date
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
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
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
db2764d941 The reference count field for PyErr_NoMemory() and 
PyErr_SetFromErrno() should be "null".
 2000-04-10 18:25:09 +00:00
Fred Drake
a4cd2611f4 Marc-Andre Lemburg <mal@lemburg.com>: 
API documentation for Unicode support from C.
 2000-04-06 14:10:29 +00:00
Fred Drake
659ebfa79e Merge in changes from the 1.5.2p2 release. 
Hopefully I got all this right!
 2000-04-03 15:42:13 +00:00
Fred Drake
eb725cd045 Merged changes from the 1.5.2p2 release. 2000-04-03 15:06:40 +00:00
Fred Drake
ddc6c276b7 Improve explanation of reference counts for PyString_Concat(). 2000-03-31 18:22:38 +00:00
Jeremy Hylton
a12c7a7620 Add PyDict_Copy() function to C API for dicts. It returns a new 
dictionary that contains the same key/value pairs as p.
 2000-03-30 22:27:31 +00:00
Fred Drake
310ee61f20 Missed a couple of program options that had been marked by \code. 1999-11-09 17:31:42 +00:00
Fred Drake
be48646cfa Use \citetitle and \programopt as appropriate. 1999-11-09 17:03:03 +00:00
Fred Drake
805bf1b330 Added note that Skip created the initial version of this file. 
Fixed up a few of his ??? comments.
 1999-10-20 16:03:38 +00:00
Fred Drake
7b7dc6b49d Initial version as provided by Skip Montanaro <skip@mojam.com>. 1999-10-20 15:06:24 +00:00
Fred Drake
c924b8d976 Clarified start parameter to Py_CompileString, documented 
Py_eval_input, Py_file_input, and Py_single_input.

Problems reported by Aaron Brancotti <aaron@icona.it>.
 1999-08-23 18:57:25 +00:00
Fred Drake
58c5a2a53c Started documentation on buffer objects & types. Very preliminary. 
Greg Stein:  Please help with this; it's your baby!
 1999-08-04 13:13:24 +00:00
Guido van Rossum
32bc45f737 Removed PyMapping_Clear() -- it was wishful thinking and serves no 
great purpose.
 1999-08-02 20:49:37 +00:00
Fred Drake
dab44682c2 PyCObject_FromVoidPtr(): Clarify that the destr function will only be 
called on destruction is non-NULL.
 1999-05-13 18:41:14 +00:00
Fred Drake
0041a94e74 Fill in a few holes in the "Very High Level" chapter. 1999-04-29 04:20:46 +00:00
Fred Drake
127ed0a71e Updated list of standard exceptions in section 4.1. 1999-02-17 23:09:05 +00:00
Fred Drake
66b989c805 Be explicit about the reference count of the original value of the 
first parameter to PyString_Concat().
 1999-02-15 20:15:39 +00:00
Fred Drake
efd146c916 Markup nits. 
Added section on module objects; described functions in
moduleobject.c.
 1999-02-15 15:30:45 +00:00
Guido van Rossum
d1dbf633ed Header for PyObject_DelItem() mentioned non-existing 3rd argument. 1999-01-22 20:10:49 +00:00
Fred Drake
2f8592cbea Ignore the byproducts of SGML/XML conversions for now. 1998-12-01 18:58:28 +00:00
Guido van Rossum
a096a2e6a2 Warn that AddModule doesn't import the module. 1998-11-02 17:02:42 +00:00
Guido van Rossum
0a0f11b6d4 PyMapping_SetItemString() returns int, not an object. 1998-10-16 17:43:53 +00:00
Guido van Rossum
ed9dcc10f8 Clarify that the Python interpreter lock need *not* be held by 
PyInterpreterState_New() and PyThreadState_New() -- but that you may
use it to serialize calls to them.
 1998-08-07 18:28:03 +00:00
Fred Drake
9f86b662d1 Update to use a separate page for front matter. 1998-07-28 21:55:19 +00:00
Guido van Rossum
a937d14898 Fred's right -- we need PyList_SET_ITEM(). 1998-04-24 18:22:02 +00:00
Fred Drake
f8830d1de5 Convert recent additions to use new, "logical" markup. 
I suppose we really do need a markup guide.  -sigh-
 1998-04-23 14:06:01 +00:00
Guido van Rossum
4447513e94 Filled in some more blanks, with the help of Drew Csillag. 1998-04-21 15:30:01 +00:00
Guido van Rossum
3c4378bd9b Some patches by Drew Csillag; plus a few of my own uncommitted changes. 1998-04-14 20:21:10 +00:00
Fred Drake
003d8da779 Typo: (and often severly limited) -- severely 
Typo: (but not to the tuple or list into which the item it put!) -- is put

Thanks, AMK!
 1998-04-13 00:53:42 +00:00
Fred Drake
c94d9348ca 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.
 1998-04-12 02:39:13 +00:00
Fred Drake
2de75ec245 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).
 1998-04-09 14:12:11 +00:00
Fred Drake
7e9d3148d1 Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00
Fred Drake
c6fa34e4d0 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.
 1998-04-02 06:47:24 +00:00
Fred Drake
f3aa0e0627 Revert the index stuff to work better with LaTeX2HTML. 1998-03-17 06:23:13 +00:00
Fred Drake
7d20ffe245 Adjust the index inclusion for the new index support. 1998-03-09 16:39:22 +00:00
Fred Drake
6659c30b67 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.
 1998-03-03 22:02:19 +00:00
Fred Drake
f39ed67fa2 Added \label{}s for logical addressing. 1998-02-26 22:01:23 +00:00
Fred Drake
b92dce38e7 PyFile_FromFile() description: make sure the closing brace for the arguments 
comes after the arguments are complete.
 1998-02-25 15:40:22 +00:00
Fred Drake
7baf3d4ea7 Fixed typo reported by Vladimir Marangozov <Vladimir.Marangozov@imag.fr>. 1998-02-20 00:45:52 +00:00
Fred Drake
9d20ac36a9 Removed various "(New in 1.5a?!)" constructs. Other notes pertaining to 
versioning remain intact.
 1998-02-16 15:27:08 +00:00
Fred Drake
4de05a90be 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.
 1998-02-16 14:25:26 +00:00
Fred Drake
53fb7723ee Added index enties for the Python built-in functions, where appropriate. 1998-02-16 06:23:20 +00:00
Fred Drake
e058b4f124 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.
 1998-02-16 06:15:35 +00:00
Fred Drake
2a4646c660 Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
Fred Drake
e5bc49785c "ASCII" --> "\ASCII{}" 1998-02-12 23:36:49 +00:00
Fred Drake
e5bf8b2c79 Reorganized a bit. No changed content. 
Guido, please take a look at new structure, at least the ToC.
 1998-02-12 21:22:28 +00:00
Fred Drake
f44617d298 For sections describing the "Foo Protocol", consistently use the capitalized 
"Protocol" and not "protocol".
 1998-02-12 20:57:15 +00:00
Fred Drake
faa1afe2d7 Py_Exit(status) calls exit(status), not exit(0). 1998-02-12 20:51:02 +00:00
Fred Drake
c6c921a4de Py_AtExit(): Added brief note about the constraint on cleanup functions not 
calling the Python API.
 1998-01-26 19:16:27 +00:00
Fred Drake
4d4f9e726a Removed \mytableofcontents; just use \tableofcontents. 1998-01-13 22:25:02 +00:00
Fred Drake
b0a78738ea Consistency: 
"Unix" ==> "\UNIX{}"

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

"C++" ==> "\Cpp{}"
 1998-01-13 18:51:10 +00:00
Fred Drake
dca8792b52 Added openright option the the \documentclass{} for each of the manuals. 1998-01-13 16:53:23 +00:00
Fred Drake
1f8449af4e Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility 
mode) and take advantage of changes in myformat.sty.
 1998-01-09 05:36:43 +00:00
Fred Drake
85a5c52752 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.
 1998-01-02 03:24:19 +00:00
Guido van Rossum
5b8a523538 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.
 1997-12-30 04:38:44 +00:00
Guido van Rossum
580aa8dbc3 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.
 1997-11-25 15:34:51 +00:00
Fred Drake
36fbe76a45 struct _frozen: 
Use spaces instead of tabs to indent structure definition; tabs don't
	work in tex/latex.

PyImport_FrozenModules:
	struct _freeze ==> struct _frozen
 1997-10-13 18:18:33 +00:00
Guido van Rossum
9faf4c57b0 Change title to {Python/C API Reference Manual}; remove \bcode \ecode 
which appears to be out of fashion in this file.
 1997-10-07 14:38:54 +00:00
Guido van Rossum
c44d3d6664 Done with tread state descriptions. Sigh! 1997-10-06 05:10:47 +00:00
Guido van Rossum
42cefd03cf Checkpoint. Added docs for the new exception handling APIs and for 
the interfaces defined in import.h.
 1997-10-05 15:27:29 +00:00
Guido van Rossum
b904629f75 Fix some badly botched prototypes for PyRun* c.s. 1997-08-21 02:28:57 +00:00
Guido van Rossum
5060b3be9b Consistently change Python-C API to Python/C API; added lots of new 
introductory text for reference counts and error handling, with good
examples.
 1997-08-17 18:02:23 +00:00
Guido van Rossum
09270b51e4 Fixes to make it pass latex without complaints. 1997-08-15 18:57:32 +00:00
Guido van Rossum
4a944d7a47 Added more stuff on initialization (still rudimentary) 1997-08-14 20:35:38 +00:00
Guido van Rossum
59a61352ad Added new intro sections (incomplete); fixed various typos 1997-08-14 20:34:33 +00:00
Guido van Rossum
ae110af13b Just another checkin for backup. Nothing substantial yet. 1997-05-22 20:11:52 +00:00
Guido van Rossum
9231c8f176 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.
 1997-05-15 21:43:21 +00:00