Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
6,930 Commits 6 Branches 593 Tags 2.4 GiB
Commit Graph

417 Commits

Author SHA1 Message Date
Fred Drake e907208b30 Some reorganization (all limit operations & constants together, and all usage 
functions and constants together).

Make explicit datadesc sections for each of the constants which might appear,
and have a description of each.  (Descriptions are based on the Linux
documentation and sources and the Solaris man pages.)

Hopefully Jeremy won't mind, because I didn't ask.  ;-)
 1997-12-06 07:25:41 +00:00
Fred Drake 0d3b4f8beb Fixed unresolved reference problem; this module wasn't \label{}ed. 
Remove spurious underscore following book title.  Added specific reference to
a Win32 networking book.

Changed \indexsubitem from (in module SocketServer) to (SocketServer protocol),
since it's talking about a protocol supported by a collection of classes.
 1997-12-04 14:36:52 +00:00
Fred Drake 98b032a7c0 Removed unnecessary escaping. 1997-12-04 14:20:59 +00:00
Fred Drake 1cf87496a6 Arg; more nits, but I may as well finish the job. 
Removed the large comment remaining from the template documentation
section; the template tells us to remove these once they're not needed.

Remove some trailing whitespace from VM instruction pseudo-code.
 1997-12-04 04:57:56 +00:00
Fred Drake 7381e28399 Fixed BINARY_RSHIFT documentation to indicate a right shift instead of a left 
shift.

Adjust whitespace around "=" in VM machine descriptions to be consistent
throughout the document.
 1997-12-04 04:51:12 +00:00
Fred Drake c2297c1ce9 Changed {\sc gdbm} to \code{gdbm} everywhere. 
Fixed \indexsubitem to gdbm instead of dbm.

Changed dbm to \code{dbm} everywhere.
 1997-12-04 04:45:28 +00:00
Guido van Rossum ab76af3d65 Provide default for blocksize on retrbinary (Skip Montanaro). 1997-12-03 19:34:14 +00:00
Fred Drake 456035f4b1 The biggie: changed the funcdesc environments used for opcode descriptions 
to use the opcodedesc environment.

Changed a \code{} to a \file{} near the start where a file is referenced.

Fixed a typo:  "on" --> "one" in ROT_THREE description.

Wherever opcodes were referenced by name, use \code{OPCODE_NAME}; usage was
inconsistent.  Ideally, another macro would be defined since these don't
represent code a programmer would type, but that's minor even for me.  It'll
probably get converted automatically in the SGML conversion project.  Whether
that matters or not isn't relevant at this point.
 1997-12-03 04:06:57 +00:00
Guido van Rossum 240ddc8a68 Typo in example (missing '=') discovered by Sandy Langbart. 1997-12-02 20:08:06 +00:00
Guido van Rossum 3593e5c4c3 Document new behavior of isinstance() when using a type object. 1997-12-02 19:15:01 +00:00
Barry Warsaw 433c8ca328 Removed Queue.py. It's documented now. 1997-12-01 16:35:54 +00:00
Fred Drake 798654fc68 Added \indexsubitem definition; functions were previously indexed for the 
wrong module.
 1997-11-30 05:53:22 +00:00
Fred Drake 2478f9d5a2 Added \indexsubitem definition. Non-optimal, but two modules are sharing 
the documentation here.
 1997-11-30 05:38:44 +00:00
Fred Drake 92796d1f01 Added \indexsubitem definition; functions were previously indexed for the 
wrong module.
 1997-11-30 05:27:26 +00:00
Fred Drake 7730cc067f Updated \indexsubitem; functions had been indexed for the wrong module. 1997-11-30 05:23:47 +00:00
Guido van Rossum 73ec2c0081 Slip of the keyboard (f__ should be __). Dunno why I had a totally 
messed up (but not checked in) version in my work files and didn't
notice before releasing 1.5 -- at least the distributed latex file
doesn't have the bogus warning about changed __init__ semantics.
 1997-11-27 01:39:15 +00:00
Guido van Rossum ee9f820cf1 Documented brand new behavior of sys.ps1 and sys.ps2 (str() is applied 
to get the actual prompt).
 1997-11-25 21:12:27 +00:00
Fred Drake e624e0f99e Removed leading comment about this being "introductory" documentation; 
compared to most, I'd say this section is fairly thorough.

Fixed \indexsubitem definitions for symbol and token module sub-documents.
Perhaps these should be moved to their own files, but they're awefully
small.
 1997-11-25 04:04:00 +00:00
Guido van Rossum f259efe3d9 Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
Guido van Rossum 3e1e274d0b Don't use $math$ mode to typeset a simple '>' sign. Use \code, not \samp. 1997-11-25 00:43:34 +00:00
Guido van Rossum 9d62e80e46 Remove strange use of $math$ mode to produce a backslash. 1997-11-25 00:35:44 +00:00
Guido van Rossum 5b7220f7ee Oops, did the previous delete the wrong way. 1997-11-25 00:05:12 +00:00
Guido van Rossum d5da7a63c1 Get rid of last traces of module 'audio' 1997-11-24 23:59:31 +00:00
Guido van Rossum 00f1569983 Add fileinput. 1997-11-24 17:50:09 +00:00
Guido van Rossum bc12f78bb3 Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +00:00
Guido van Rossum e084f0beea Add description for some modules that have been added since this intro 
section was last revised...
 1997-11-20 21:03:33 +00:00
Guido van Rossum 3472026347 Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
Barry Warsaw 17c8e781c0 libqueue.tex: Documentation for the Queue.py module. 
Makefile: Add dependency on libqueue.tex

lib.tex: Place the libqueue.tex documentation just after libthread.tex
since Queue depends on thread support in Python.
 1997-11-20 19:54:16 +00:00
Barry Warsaw 4552f3d6de In the description of sub(), give a better explanation of the 
interface when repl is a function.  Also give a simple example of
using a function repl.
 1997-11-20 00:15:13 +00:00
Guido van Rossum 2974f0fe9a Add xmllib; remove (slow) from description of htmllib. 1997-11-18 15:30:40 +00:00
Guido van Rossum 7336935e4c dis is now documented; bisect is deemed useful. 1997-11-18 15:30:13 +00:00
Guido van Rossum f7790c608d Document s.connect_ex(), which does not raise an exception on error. 1997-11-18 15:29:20 +00:00
Guido van Rossum 364e643fdd Clarified reference to old profiler. 
Mention conversion to Perl-style regular expressions.
 1997-11-18 15:28:46 +00:00
Guido van Rossum 5de64883d8 Added doc for errorcode dictionary. 1997-11-18 15:27:51 +00:00
Guido van Rossum eae121e436 Adding dis and xmllib docs 1997-11-18 15:11:47 +00:00
Guido van Rossum a10768ae44 Docu for xmllib.py, by Sjoerd Mullender. 1997-11-18 15:11:22 +00:00
Guido van Rossum b62b6d145e Docu for dis.py, written by Martin von Loewis. 1997-11-18 15:10:53 +00:00
Guido van Rossum 9d37a4d332 Small wording change about global and local trace functions. 1997-10-27 19:57:20 +00:00
Fred Drake 040e565261 Ooops, found too more references to old conditions on floating point values. 1997-10-24 21:15:55 +00:00
Fred Drake ae18e9fc1c Removed obsolete discussion on _xdr helper module. 1997-10-24 21:14:36 +00:00
Guido van Rossum d7dc2eb708 Put {} around \^ in sets to force latex2html to do the right thing... 1997-10-22 03:03:44 +00:00
Guido van Rossum 828a0bdb1d count() now has a 4th parameter too. Also rephrased the docs for find 
to use the same, better words to explain start/end.
 1997-10-20 22:40:26 +00:00
Guido van Rossum 871cf161f1 Documented exc_info(); also updated exc_type and last_type docs. 1997-10-20 22:38:43 +00:00
Fred Drake 2950b2d881 Restore the \seealso formatting that got lost when I updated the math 
module documentation.
 1997-10-13 22:06:17 +00:00
Fred Drake 7cd60442b4 Remove macpath entry -- it is already documented. 1997-10-13 22:02:09 +00:00
Fred Drake 5451d67dd9 socket_type ==> SocketType 1997-10-13 21:31:02 +00:00
Fred Drake 120ac20c40 Remove superfluous comman from between "not" and "in" when describing the 
"not in" operator.
 1997-10-13 20:48:17 +00:00
Guido van Rossum 6cd7ecb10b The sequence behavior is now on the Exception root class rather than 
on the StandardError class.
 1997-10-07 14:41:04 +00:00
Fred Drake 6f2a26d42b And "ni" has been documented... 1997-10-06 21:53:50 +00:00
Fred Drake 2df75832b3 Oops; don't know if this was my typo or not: There was a "p" on a line that 
should have been blank.
 1997-10-06 21:52:31 +00:00
Fred Drake c211254334 Updated the section "Parsing Python". 1997-10-06 21:41:30 +00:00
Fred Drake 14bf341f16 Added keyword module entry. 1997-10-06 21:40:48 +00:00
Fred Drake e061a51de1 Minor nits (Lib/token.py is a file, token is a module...). 
Added docs for symbol and token modules at the end.
 1997-10-06 21:40:20 +00:00
Fred Drake db12f343bc Documentation for the keyword module. 1997-10-06 21:39:16 +00:00
Fred Drake 00eb96a126 Move the pprint docs after the code docs, so that all parser/codegen type 
things come together.
 1997-10-06 21:26:03 +00:00
Barry Warsaw dc0f00ad03 Document the mapping object's new get() method. 1997-10-06 17:50:48 +00:00
Guido van Rossum 0bfd146594 Added strerror() 1997-10-05 18:54:52 +00:00
Guido van Rossum bc3b13643d Removed emacs.py 1997-10-05 18:54:36 +00:00
Guido van Rossum eb53ae4928 Fixed some stuff that was incorrectly copied from regex. 1997-10-05 18:54:07 +00:00
Guido van Rossum 7974b0f2d8 Documented __import__, callable, isinstance, issubclass, 
and slice.
 1997-10-05 18:53:00 +00:00
Guido van Rossum df3dba049d Documented new exceptions and exception classes. 1997-10-05 18:51:26 +00:00
Fred Drake b55e07f4eb Fixed up formatting. 1997-09-30 21:59:27 +00:00
Fred Drake 1b914b3397 Fixed up formatting, added descriptions for previously undocumented functions. 1997-09-30 20:14:50 +00:00
Guido van Rossum 3cdb8f3286 Update the description and the example to the new functionality, which 
is mostly concentrated in a generalized find_module() and the new
load_module().  Added the new module type constants.  Declare that
SEARCH_ERROR and a whole bunch of module-type-specific functions are
obsolete.
 1997-09-09 20:53:37 +00:00
Guido van Rossum 9cf4e2bde7 Change packages to site-packages (so it's clearly not a package itself). 1997-09-08 02:02:37 +00:00
Guido van Rossum 16221126d6 Added warning about ni's obsolescence. Retracted semantic changes 
(i.e. when using ni, the old __init__.py semantics prevail!)
 1997-09-07 03:02:39 +00:00
Guido van Rossum 593801142e Initial revision 1997-09-07 02:56:35 +00:00
Guido van Rossum f01dff7e93 Give in to Mike Meyer -- add *both* lib/python1.5/packages and 
lib/site-python to the path (if they exist).  This is a reasonable
compromise.
 1997-09-03 22:05:54 +00:00
Guido van Rossum 28cad964ec Document newly revamped site configuration mechanism. 
Damn the criticism in c.l.p!
 1997-08-30 20:03:28 +00:00
Guido van Rossum 36764b8b0e Added docs for 'user' customization module. Renamed libuser.tex 
(which had UserDict/UserList) to libuserdict.tex.
 1997-08-30 20:02:25 +00:00
Guido van Rossum b2afc811c2 Added os.altsep; this is '/' on DOS/Windows, and None on systems with 
a sane filename syntax.
 1997-08-29 22:37:44 +00:00
Guido van Rossum 282290f821 Referred to POSIX docs as well as to Unix docs. 1997-08-27 14:54:25 +00:00
Guido van Rossum e20aef574a Ignore whitespace between formats (not internal to a count+format). 1997-08-26 20:39:54 +00:00
Guido van Rossum 81e479a11f Removed some colons that shouldn't be there (probably leftovers from 
docstring conversion).
 1997-08-25 18:28:03 +00:00
Guido van Rossum 08157f8db6 mention cPickle and cStringIO 1997-08-21 02:29:19 +00:00
Guido van Rossum e229d8636d Misc Mac mods by Jack. Added libmacic.tex, and these patches: 
libmacfs.tex	Document NewAliasMinimalFromFullPath
libmacos.tex	Document SetEventHandler and SchedParams
libmacui.tex	Document asynchronous event handling
libmailbox.tex	Removed mime-turds that somehow got in here
 1997-08-18 15:14:26 +00:00
Guido van Rossum 9085822f28 the usual 1997-08-15 02:52:46 +00:00
Guido van Rossum 1acceb0650 Added AMK's first cut at docs for re.py 1997-08-14 23:12:18 +00:00
Guido van Rossum 3572d3718b Updated platform specific notes (it is now more common to have this) 
added some caveats.
 1997-08-14 19:51:26 +00:00
Guido van Rossum 8f06247b51 Added buffer_info() docs. 1997-08-14 19:50:37 +00:00
Guido van Rossum fcaf26e245 Documented mime_decode_header() and mime_encode_header(). 1997-08-14 14:13:01 +00:00
Guido van Rossum 9c43c590bc More emphasis on os.environ's calling of putenv; and added hint about 
flags for open().
 1997-08-08 21:05:09 +00:00
Guido van Rossum fd16ca4542 Added mimify docs (Sjoerd). 1997-07-30 22:05:07 +00:00
Fred Drake 12d9eac0a2 A couple of grammatical nits. 
Re-sequenced the function descriptions so that the formatting is described
before the assumption is made that the reader has a clue about the formatting.

Moved examples to be closer to the functions being demonstrated.

Added example of saferepr() result.
 1997-07-24 15:39:16 +00:00
Guido van Rossum 6576dd6ad6 Document new 'quote' flag to cgi.escape(). 1997-07-19 20:16:07 +00:00
Guido van Rossum 61c270345c added code.py; codehack.py is obsolete 1997-07-18 21:08:07 +00:00
Guido van Rossum 1c78cf3317 Added label{module-spam} 1997-07-18 21:07:34 +00:00
Fred Drake ca1182b262 Remove pprint from the list of undocumented modules. 1997-07-18 20:44:22 +00:00
Fred Drake d2b9f81ec5 Add entry for the pprint module. 1997-07-18 20:43:53 +00:00
Fred Drake ee8d3ca4cf Documentation for the pprint module. 1997-07-18 20:41:58 +00:00
Guido van Rossum b15e5ed689 Use 'and' instead of '&', which is a (La)TeX control character. 
"make lib tut ext" should now be errorfree.
 1997-07-17 18:30:15 +00:00
Guido van Rossum e47da0ae04 AMK's megapatch: 
* \bcode, \ecode added everywhere
	* \label{module-foo} added everywhere
	* A few \seealso sections added.
	* Indentation fixed inside verbatim in lib*tex files
 1997-07-17 16:34:52 +00:00
Guido van Rossum 3c2a056fdd Extensive changes by AMK. 1997-07-17 16:29:42 +00:00
Guido van Rossum 5320998da5 Note that getvalue() must be called before close(). 1997-07-17 16:29:04 +00:00
Guido van Rossum 0fcbe8dde2 Added libni.tex libgzip.tex 1997-07-17 16:27:42 +00:00
Guido van Rossum 41884a9b1c New from AMK 1997-07-17 16:26:11 +00:00
Guido van Rossum eb1633ec6e Removed mailbox, SocketServer, cmath -- these are now documented! 1997-07-17 16:21:18 +00:00
Guido van Rossum 84057a3874 Added cmath 1997-07-17 16:15:18 +00:00
Guido van Rossum 246d96555f Typo in example. 1997-07-17 16:14:12 +00:00
Guido van Rossum 14a8024b04 New cmath module docs, by AMK (with additions and deletions by Guido). 1997-07-17 16:13:45 +00:00