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

1193 Commits

Author SHA1 Message Date
Guido van Rossum 7969f31c4d Updated documentation by Per Cederqvist. I've added back the 
documentation sendmail() to reflect the changes by The Dragon
(see smtplib.py checkin).
 1999-04-07 15:56:51 +00:00
Fred Drake 4f21d54764 Added more "See also" entries, + 1 inline hyperlink. 1999-04-05 22:18:12 +00:00
Fred Drake ea003fcc2a Fixed latex2html weirdness with footnotes. 1999-04-05 21:59:15 +00:00
Jeremy Hylton 45b0aeda3c correct version info for zlib. 
add note about module failing with old versions of the library.

update comment that explains that this doc is *still* out of date
 1999-04-05 21:55:21 +00:00
Fred Drake 9aa8543c84 open() description: Made it more clear that 'b' should always be 
added to the mode value for binary files to improve
	portability.

Fixed latex2html weirdness with a couple of footnotes.
 1999-04-05 21:22:41 +00:00
Fred Drake 01553706bf Added a few items to the "See also" sections at Guido's prompting. Made 
more references to other modules in the text hyperlinks for the HTML and
PDF versions.
 1999-04-05 19:46:21 +00:00
Fred Drake 50ae47b0de Removed bosities around example code; not sure where that stuff crept 
in!
 1999-04-05 19:26:16 +00:00
Fred Drake 1dc3a501a6 Made improvements based on changes just made and comments from 
Bernhard Reiter <bernhard@csd.uwm.edu>.
 1999-04-05 19:00:54 +00:00
Fred Drake 806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +00:00
Guido van Rossum cb1f2420ea Document complex() with string arg. 1999-03-25 21:23:26 +00:00
Guido van Rossum 5fc9c869dd SIGTERM is no longer caught to call sys.exitfunc. 
This change was made long ago but the documentation was never updated.
 1999-03-25 20:30:00 +00:00
Fred Drake e82f5b3d6e Added note about ftpmirror.py, since that seems to be one of the most 
requested Python tools/examples.
 1999-03-25 05:04:17 +00:00
Guido van Rossum 8be229650d Document new builtin buffer(). Greg Stein. 1999-03-19 19:10:14 +00:00
Fred Drake 596766772e Documented FTP.set_pasv(). 1999-03-18 16:08:54 +00:00
Fred Drake 154d909993 Note that abspath() was added in 1.5.2. 1999-03-17 22:25:11 +00:00
Fred Drake 8d2c0c2ab4 Fixed minor nits, added index entries to make these easier to find for people 
not familiar with Unix terminology.
 1999-03-16 16:40:01 +00:00
Fred Drake 658cef0141 Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip! 1999-03-15 15:44:18 +00:00
Fred Drake bf5a6d2eb4 Fixed tons of small markup problems. 1999-03-12 19:57:38 +00:00
Fred Drake b3a20bc44c Added availabililty annotations to respond to concerns of /F. 1999-03-12 18:34:21 +00:00
Fred Drake 93503ca57b Fixup the module keys. There were some problems with hosting / processing 
file HTML files on Windows machines do to case insensitivity.
 1999-03-12 16:24:22 +00:00
Fred Drake be110c1706 Updates based on comments from /F. 1999-03-12 15:27:35 +00:00
Fred Drake 35c3ffdc3f Fixed description of WSTOPSIG(), added WTERMSIG(). Problem reported 
by Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-03-04 14:08:10 +00:00
Fred Drake a54a887f66 "\platform{UNIX}" should really be spelled "\platform{Unix}". 1999-03-02 17:03:42 +00:00
Fred Drake f6863c1909 Added \platform annotations. 1999-03-02 16:37:17 +00:00
Fred Drake 43b34da656 extract_tb(): Only describe this function once. Problem reported by 
Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-02-26 18:51:21 +00:00
Fred Drake 390636382a Typo: "Availabilty" --> "Availability" 
Thanks to /F!
 1999-02-26 14:05:02 +00:00
Fred Drake 51027c4173 Added note about comments, from Christopher Petrilli. 1999-02-24 22:36:44 +00:00
Fred Drake 16e81f4484 Update some of the top comments and shorten title of the first 
section.
 1999-02-24 19:57:14 +00:00
Barry Warsaw f2b4554403 Document the correct class hierarchy for SystemExit. It is not an 
error and so it derives from Exception and not SystemError.
 1999-02-24 00:27:14 +00:00
Fred Drake 1ec71cb556 Incorporated updates to describe geturl() by Sjoerd Mullender 
<Sjoerd.Mullender@cwi.nl>.
 1999-02-22 22:42:14 +00:00
Fred Drake 00a3a65cc0 Refer to the right RFC in the intro. 1999-02-22 17:12:42 +00:00
Fred Drake 7d9b13325d Other chapter titles refer to collections of modules as "Services"; do 
the same here.
 1999-02-22 14:48:00 +00:00
Fred Drake fab41f1788 BabylMailbox description: Properly escape the backslashes in the 
string representations.
 1999-02-22 14:26:16 +00:00
Fred Drake b63e77ccb0 Oops, used a \label twice - fix one of them. 1999-02-22 14:14:48 +00:00
Fred Drake 180b68b3cf More reasonable section titles. 1999-02-22 13:45:09 +00:00
Fred Drake 76991ec75a Shorten section title. 1999-02-20 05:20:49 +00:00
Fred Drake 199b79c37b Added descriptions for BabylMailbox and Maildir (Qmail) mailbox 
objects.
 1999-02-20 05:04:59 +00:00
Fred Drake 67d229ea76 Shorten section title. 1999-02-20 04:51:16 +00:00
Fred Drake bbac43223c Shorten a few section titles. 1999-02-20 00:14:17 +00:00
Fred Drake da57365337 Give subsections reasonable file names in the HTML. 1999-02-19 23:48:05 +00:00
Fred Drake 342501142d Added an index entry. 1999-02-19 23:45:06 +00:00
Fred Drake 56f8185a53 Shortened the short synopsis -- too long. 1999-02-19 22:59:56 +00:00
Fred Drake 9f03380d1c Use more current approach to recording authors. 1999-02-19 22:56:08 +00:00
Fred Drake c60047575d Shortened the short synopsis -- way too long. 1999-02-19 22:33:51 +00:00
Fred Drake d8a41e6391 Fix an amazing number of typos & malformed sentences reported by Detlef 
Lannert <lannert@uni-duesseldorf.de>.
 1999-02-19 17:54:10 +00:00
Fred Drake f6346345b0 Noted that the module was added in 1.5.2. 1999-02-19 15:46:38 +00:00
Fred Drake 4e7c205470 Update description of what modules "look like" when printed. 1999-02-19 15:30:25 +00:00
Fred Drake cd71aa2a38 Use current approach to record documentation author. 1999-02-18 21:13:03 +00:00
Fred Drake 2a2f1fe4d5 Record module & documentation author. 1999-02-18 21:10:32 +00:00
Fred Drake 6b103f1e12 Documentation for pyclbr and tokenize modules. 1999-02-18 21:06:50 +00:00
Fred Drake 4d358b5d23 Added sections for pyclbr and tokenize. 1999-02-18 20:40:26 +00:00
Fred Drake 7c829b3179 Remove the "Parsing Python" section. Hurray! 1999-02-18 20:39:44 +00:00
Fred Drake 70a66c9d6d Add notes to __builtin__.float() and string.atof() that the NaN and Inf 
results are possible but non-portable.
 1999-02-18 16:08:36 +00:00
Fred Drake 951eea4733 atof() description: Add information about accepting 'NaN' to produce 
the NaN value.
 1999-02-18 03:49:20 +00:00
Fred Drake 85a59dd68b The _O_* constants are defined as O_* in the os module. 1999-02-16 19:41:01 +00:00
Fred Drake 9329e5ec75 Remove "_" from the P_* symbols used with the spawn*() functions. 1999-02-16 19:40:19 +00:00
Fred Drake c7b72dbbca Added chapter on Windows modules, including msvcrt and winsound. 1999-02-16 19:18:38 +00:00
Fred Drake aa1afa8d30 Added availability notes for samefile(), sameopenfile(), samestat() 
since these are not available on Windows.
 1999-02-15 16:34:00 +00:00
Fred Drake 9474d86242 Make sure all HTML pages generated from this section have reasonable 
names.

Markup nits.
 1999-02-12 22:05:33 +00:00
Fred Drake 2d2b6a0074 Markup nits. 1999-02-12 20:40:49 +00:00
Fred Drake 28bc711f5f Added section for MimeWriter, contributed by Christopher Petrilli 
<petrilli@amber.org>.

This spells the end of another whole section in the undoc chapter!
 1999-02-12 19:26:09 +00:00
Fred Drake 26b698fa4d Document <complex #>.conjugate(). 1999-02-12 18:27:31 +00:00
Guido van Rossum ce67f06491 Update documentation to reflect changes to Queue.py by Tim Peters. 1999-02-08 18:43:13 +00:00
Fred Drake d673d481f5 Document sameopenfile(), samestat(). 1999-02-03 22:31:30 +00:00
Fred Drake 0256c1f453 Document splitdrive(). 
For all split*(), these split path *into* pairs, not split path *in*
pairs.  "Into" can be used for transformations, "in" is for
containment.
 1999-02-03 19:24:44 +00:00
Guido van Rossum 0c9608cf1b Portability fix for [f]statvfs() return tuple: no longer return the 
f_fsid field, since it's not a scalar on all systems supporting this
call (in particular, it's a tuple of two longs on AIX).  Since it's
not particularly useful, just nuke it.  Adapted the doc strings too.
 1999-02-03 16:32:37 +00:00
Fred Drake 215fe2f204 Fix the os/posix documentation issue. 1999-02-02 19:02:35 +00:00
Fred Drake dda199b261 Moved \versionadded to end of description sections. 1999-02-02 19:01:37 +00:00
Fred Drake 12ba7868e4 Moved posixpath to os.path. 1999-02-02 19:00:37 +00:00
Fred Drake 560bcae0f0 Added posixpath, winsound. 1999-02-02 18:59:58 +00:00
Fred Drake a9b9bf96fe Change this to be os.path. 
Use consistent parameter naming with the os documentation (paths
always named "path" or "path1", "path2"...).
 1999-02-02 18:58:33 +00:00
Fred Drake d0bceeeb59 Move \versionadded macros to end of descriptions. 1999-02-02 18:00:40 +00:00
Guido van Rossum 09da65ef2f Patch by Sjoerd Mullender to placate /F: 
Clarified (hopefully :-) the documentation of elements and attributes
variables.
 1999-02-02 17:55:12 +00:00
Fred Drake dbd72a4e4f Added module synopsis. 1999-02-01 21:27:59 +00:00
Fred Drake 68a8c69499 Take out just about everything and refer the reader to the os module. 1999-02-01 20:23:02 +00:00
Fred Drake b23ee1d899 Make the text generic, and call it os.path instead of posixpath. 1999-02-01 20:20:39 +00:00
Fred Drake 98be47e737 OSError description: "as the by the" --> "as the" 1999-02-01 16:17:40 +00:00
Guido van Rossum 1804dc3c07 Document abspath() (implementation is forthcoming). 1999-01-29 18:05:05 +00:00
Fred Drake 703b70e260 Added \modulesynopsis. 1999-01-28 19:30:49 +00:00
Fred Drake 9d814c6805 Document the repr module. This removes the entire "Code objects and 
files, debugger etc." section from "Undocumented Modules"!
 1999-01-27 17:20:33 +00:00
Fred Drake da452bf6a7 Don't say that the module defines the "following functions" and then 
only describe one; say "following function" instead!

Merge the two one-sentence paragraphs into a single paragraph, so it
doesn't look too stupid.
 1999-01-27 15:48:23 +00:00
Fred Drake ebe2a12de8 Incorporate changes for patched version of ConfigParser. 1999-01-26 21:49:05 +00:00
Fred Drake bc866ce2e3 Documentation for the ConfigParser module, by Christopher G. Petrilli 
(petrilli@amber.org).
 1999-01-26 15:47:59 +00:00
Guido van Rossum 9700e9becc Document the default for tabsize in expandtabs(). 1999-01-25 22:31:53 +00:00
Fred Drake 19a0dba342 Add caveat on partial dependence on the "cl" module, only available on 
IRIX systems.
 1999-01-20 16:26:09 +00:00
Fred Drake 9ea3e36419 Move the jpeg module to the SGI section; it is dependent on the "cl" 
module available on IRIX.
 1999-01-20 15:55:20 +00:00
Fred Drake a7998f650a Revised comments on null bytes in pattern string. 
Removed "New" from module synopsis.
 1999-01-19 20:00:08 +00:00
Fred Drake 6ffa445832 Fix second description of handling 2-digit years (last item in 
introductory text).
 1999-01-19 19:35:18 +00:00
Fred Drake 7eca8e5017 Fix typo spotted by Jeff MacDonald <jam@ans.net>. 1999-01-18 15:46:02 +00:00
Barry Warsaw 53610caee2 for method getaddrlist(): Added a note clarifying that all named 
headers and their continuation lines are parsed.
 1999-01-14 21:26:54 +00:00
Fred Drake e36e4e6778 Use \refmodule when we say "use the XXX module instead". 
For the whatsound module, point to sndhdr.
 1999-01-13 17:11:52 +00:00
Fred Drake 39cddb7439 Added \modulesynopsis. 1999-01-12 19:22:11 +00:00
Fred Drake 03dd3efd5a <writer>.send_paragraph(): Clarify what needs to be done by this 
method and what it should not do.  (Specifically: handling
	breaking of last line of preceeding paragraph.)
 1999-01-12 18:33:47 +00:00
Fred Drake bb3b0028ba Patches describing the statvfs() and fstatvfs() functions. Additional 
text about large file support.

All new text by Steve Clift <clift@mail.anacapa.net>, with only minor
revision / addition of markup.
 1999-01-11 18:36:23 +00:00
Fred Drake c7dd3e11da Markup nit. 
Add module synopsis.
 1999-01-07 15:45:55 +00:00
Guido van Rossum cf3ce92ef4 Explain how come that pickle and cPickle, while using the same data 
format, can produce different pickle strings for the same object.
 1999-01-06 23:34:39 +00:00
Guido van Rossum 87e611e441 Replace the docs for reduce with an adaptation of its docstring, which 
was actually clearer!
 1999-01-06 23:10:51 +00:00
Guido van Rossum 74429eacb5 Add doc for access() and ttyname(). Patch by Sean Reifschneider. 1999-01-06 23:03:43 +00:00
Fred Drake c553358c63 Remove documentation for whatraw() since it's gone now. 1999-01-06 15:21:19 +00:00
Fred Drake 60adb362df Document the sndhdr module. 
Document that the whatsound module is obsolete.
 1999-01-05 23:09:12 +00:00
Fred Drake a2e4017394 Shorten the synopsis that gets into the table of contents. 1999-01-05 22:54:49 +00:00
Fred Drake 02e18b4b84 Added missing "from" in IOError description. 1999-01-05 21:42:18 +00:00
Andrew M. Kuchling f07c328c07 Document the optional mode argument (Z_FLUSH, Z_SYNC_FLUSH, etc.) 
to the flush() method of compressor objects.
 1998-12-31 21:14:23 +00:00
Fred Drake 94c4a7976f Added index entries to make it easier to locate directory & file operations. 1998-12-28 21:58:57 +00:00
Fred Drake 8692998018 Added index entries to make it easier to locate directory operations. 1998-12-28 21:58:15 +00:00
Fred Drake 76fa3b73d6 Remove recently documented modules from the undoc list. 1998-12-28 20:53:19 +00:00
Fred Drake 449e18f459 Add documentation for shutil module. 1998-12-28 20:16:58 +00:00
Fred Drake cd058539a8 Adjust a few niggles that affected the HTML conversion (a couple of 
"^"s were being dropped in the context of [^...]).
 1998-12-28 19:03:24 +00:00
Fred Drake 99e2c39b31 Add the getpass module. 1998-12-22 23:37:46 +00:00
Fred Drake 5ac2a07fca Basic documentation for the getpass module. 1998-12-22 23:37:21 +00:00
Fred Drake 5cb48a4c98 Added a \versionchanged since the API changed to support 
namespaces with 1.5.2.

Added an index entry.

Fixed XML expansion:  XML is the "Extensible Markup Language", not the
"eXtended Markup Language".
 1998-12-22 18:46:13 +00:00
Fred Drake 292b9ebfba Added information on when this was added, allowing us to release the 
documentation on the Web while people are still using < 1.5.2b1.
 1998-12-22 18:40:50 +00:00
Fred Drake 1189fa98eb Adjust markup to match current conventions, and make it formattable. 1998-12-22 18:24:13 +00:00
Fred Drake 768ac6b804 Start of text that describes differences between match and search. 
Strengthen pointers to the search() function and method.
 1998-12-22 18:19:45 +00:00
Fred Drake 191f2857f5 Use \moduleauthor and \sectionauthor instead of a comment to credit 
the author (just happened to notice this one).
 1998-12-22 18:06:02 +00:00
Fred Drake 7be0cde3a0 Add an explanation about what the example does and doesn't do. 
Fix an appearantly new behavior with latex2html with quoting.  (Good
incentive to work on the SGML conversion! ;)
 1998-12-22 18:04:48 +00:00
Guido van Rossum 5e97c9dff9 Adding libshlex and libnetrc by Eric Raymond. 1998-12-22 05:18:24 +00:00
Fred Drake e848976fba Clarify descriptions of some operations; it's not always clear that 
strings are not actually modified.  Problem reported by Dr. Peter
Stoehr <peter.stoehr@weihenstephan.org>.
 1998-12-21 18:56:13 +00:00
Fred Drake 3b02ddfa41 Add a bunch of index entries related to retrieving information from 
the process table.
 1998-12-21 18:52:53 +00:00
Guido van Rossum b083a9fb54 Sjoerd Mullender writes: 
Here is my current version of xmllib.py and the documentation.  This
version has some API changes with respect to the version currently in
Python (also the one in 1.5.2a).
This version supports XML namespaces.
 1998-12-18 20:17:13 +00:00
Fred Drake fee6abea90 Remove another {\rm ...} construct. 
Sheesh, where do these things come from?
 1998-12-10 19:57:52 +00:00
Fred Drake e9e05968e3 Nits. 1998-12-10 05:04:21 +00:00
Fred Drake 0ad55fb241 Update the descriptions of strftime() and strptime() to avoid 
confusion, and describe what the "directives" are about.
 1998-12-08 19:59:36 +00:00
Guido van Rossum aac399b80b Correct the poplib example. Stephan Richter pointed out some problems 
with it.
 1998-12-08 16:30:10 +00:00
Fred Drake 64583d3f87 Rename the parameters of atan2(), based on comments from Guido & Peter 
A. Koren <pkoren@hex.net>.
 1998-12-08 16:10:44 +00:00
Guido van Rossum f484a3366b Sjoerd writes: 
When literal mode is entered it should exit automatically when the
matching close tag of the last unclosed open tag is encountered.  This
patch fixes this.
 1998-12-07 21:59:56 +00:00
Fred Drake d83675f344 "singed" --> "signed" (3 places) 
Noticed by Andrew MacIntyre <andymac@bullseye.apana.org.au>.
 1998-12-07 17:13:18 +00:00
Guido van Rossum 8c2da61811 Add explicit example on how to import a submodule of a package using 
__import__ and getattr().
 1998-12-04 15:32:17 +00:00
Barry Warsaw 6d26f4b188 Moved NotImplementedError into alphabetical order, and reword 
description.
 1998-12-01 19:48:04 +00:00
Barry Warsaw 1e151322fb Added documentation for NotImplementedError. Fred (I'm sure) will 
sanitize for your protection :-)
 1998-12-01 19:19:21 +00:00
Fred Drake 2f8592cbea Ignore the byproducts of SGML/XML conversions for now. 1998-12-01 18:58:28 +00:00
Fred Drake eabfab1048 Nits to support conversions. 1998-12-01 18:37:59 +00:00
Fred Drake 1e270f0e03 Nits to support conversions. 1998-11-30 22:58:12 +00:00
Fred Drake 50b804dc88 Fix minor nit with respect to conversion. 
Update some logical markup.
 1998-11-30 22:14:58 +00:00
Fred Drake caa3379c4f Remove {\rm ...} constructs. 1998-11-30 21:53:47 +00:00
Fred Drake 84538cd076 Remove some remaining {\rm ...} constructs. 
Update logical markup in a few spots.
 1998-11-30 21:51:25 +00:00
Fred Drake 1776556f8f Markup nit to ease conversions. 1998-11-30 19:00:16 +00:00
Fred Drake 3d29955a6e Markup improvements to help with conversions. 1998-11-30 18:59:44 +00:00
Fred Drake 01d5d94020 Remove cruft from the old Texinfo conversion. This simplifies some of 
the newer processing.
 1998-11-30 17:33:38 +00:00
Fred Drake 5208823158 Remove bogus \@. 1998-11-30 16:27:37 +00:00
Fred Drake d61975e179 Minor markup nit to ease conversion processing. 1998-11-30 16:26:50 +00:00
Fred Drake f6c59e8fff Do all the right imports. Problem reported by Martijn Faassen 
<faassen@vet.uu.nl>.
 1998-11-30 15:07:26 +00:00
Fred Drake 4471f20ed4 Logical markup. 
Fix a few things for the conversion to structured markup.

Removed texinfo special cases, since there's likely a new info
process.
 1998-11-25 22:38:24 +00:00
Fred Drake f65e323101 Fix remaining {\rm ...} construct. 1998-11-25 20:55:03 +00:00
Guido van Rossum 5eabf3823b Clarify that min and max also take multiple arguments. 1998-11-25 18:53:05 +00:00
Fred Drake e839199014 Fix indexing of func_code attribute; this is on a function, not a code 
object.

Add "()" to method names indexed using \ttindex{}.
 1998-11-25 17:09:19 +00:00
Guido van Rossum 04307ce789 Rewrote the section on sys.exit(), documenting other argument types 
than integers and recommending sys.exit("message").
(I see this as Python's answer to Perls ``die "message";''.)
 1998-11-23 17:49:53 +00:00
Guido van Rossum da30f4ca6b Fix typo in doc for handle(): client_request should be client_address. 
Noted by Stefan Witzel.
 1998-11-16 19:07:04 +00:00
Fred Drake c46973c89b Document the user and password parameters to the NNTP constructor. 1998-11-16 17:11:30 +00:00
Fred Drake 2510d22048 Clarify the default buffering for open(). (Comment from Andrew Dalke 
<dalke@bioreason.com>).
 1998-11-02 18:57:34 +00:00