658cef0141
Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip!
1999-03-15 15:44:18 +00:00
bf5a6d2eb4
Fixed tons of small markup problems.
1999-03-12 19:57:38 +00:00
b3a20bc44c
Added availabililty annotations to respond to concerns of /F.
1999-03-12 18:34:21 +00:00
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
be110c1706
Updates based on comments from /F.
1999-03-12 15:27:35 +00:00
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
a54a887f66
"\platform{UNIX}" should really be spelled "\platform{Unix}".
1999-03-02 17:03:42 +00:00
f6863c1909
Added \platform annotations.
1999-03-02 16:37:17 +00:00
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
390636382a
Typo: "Availabilty" --> "Availability"
...
Thanks to /F!
1999-02-26 14:05:02 +00:00
51027c4173
Added note about comments, from Christopher Petrilli.
1999-02-24 22:36:44 +00:00
16e81f4484
Update some of the top comments and shorten title of the first
...
section.
1999-02-24 19:57:14 +00:00
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
1ec71cb556
Incorporated updates to describe geturl() by Sjoerd Mullender
...
<Sjoerd.Mullender@cwi.nl>.
1999-02-22 22:42:14 +00:00
00a3a65cc0
Refer to the right RFC in the intro.
1999-02-22 17:12:42 +00:00
7d9b13325d
Other chapter titles refer to collections of modules as "Services"; do
...
the same here.
1999-02-22 14:48:00 +00:00
fab41f1788
BabylMailbox description: Properly escape the backslashes in the
...
string representations.
1999-02-22 14:26:16 +00:00
b63e77ccb0
Oops, used a \label twice - fix one of them.
1999-02-22 14:14:48 +00:00
180b68b3cf
More reasonable section titles.
1999-02-22 13:45:09 +00:00
76991ec75a
Shorten section title.
1999-02-20 05:20:49 +00:00
199b79c37b
Added descriptions for BabylMailbox and Maildir (Qmail) mailbox
...
objects.
1999-02-20 05:04:59 +00:00
67d229ea76
Shorten section title.
1999-02-20 04:51:16 +00:00
bbac43223c
Shorten a few section titles.
1999-02-20 00:14:17 +00:00
da57365337
Give subsections reasonable file names in the HTML.
1999-02-19 23:48:05 +00:00
342501142d
Added an index entry.
1999-02-19 23:45:06 +00:00
56f8185a53
Shortened the short synopsis -- too long.
1999-02-19 22:59:56 +00:00
9f03380d1c
Use more current approach to recording authors.
1999-02-19 22:56:08 +00:00
c60047575d
Shortened the short synopsis -- way too long.
1999-02-19 22:33:51 +00:00
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
f6346345b0
Noted that the module was added in 1.5.2.
1999-02-19 15:46:38 +00:00
4e7c205470
Update description of what modules "look like" when printed.
1999-02-19 15:30:25 +00:00
cd71aa2a38
Use current approach to record documentation author.
1999-02-18 21:13:03 +00:00
2a2f1fe4d5
Record module & documentation author.
1999-02-18 21:10:32 +00:00
6b103f1e12
Documentation for pyclbr and tokenize modules.
1999-02-18 21:06:50 +00:00
4d358b5d23
Added sections for pyclbr and tokenize.
1999-02-18 20:40:26 +00:00
7c829b3179
Remove the "Parsing Python" section. Hurray!
1999-02-18 20:39:44 +00:00
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
951eea4733
atof() description: Add information about accepting 'NaN' to produce
...
the NaN value.
1999-02-18 03:49:20 +00:00
85a59dd68b
The _O_* constants are defined as O_* in the os module.
1999-02-16 19:41:01 +00:00
9329e5ec75
Remove "_" from the P_* symbols used with the spawn*() functions.
1999-02-16 19:40:19 +00:00
c7b72dbbca
Added chapter on Windows modules, including msvcrt and winsound.
1999-02-16 19:18:38 +00:00
aa1afa8d30
Added availability notes for samefile(), sameopenfile(), samestat()
...
since these are not available on Windows.
1999-02-15 16:34:00 +00:00
9474d86242
Make sure all HTML pages generated from this section have reasonable
...
names.
Markup nits.
1999-02-12 22:05:33 +00:00
2d2b6a0074
Markup nits.
1999-02-12 20:40:49 +00:00
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
26b698fa4d
Document <complex #>.conjugate().
1999-02-12 18:27:31 +00:00
ce67f06491
Update documentation to reflect changes to Queue.py by Tim Peters.
1999-02-08 18:43:13 +00:00
d673d481f5
Document sameopenfile(), samestat().
1999-02-03 22:31:30 +00:00
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
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
215fe2f204
Fix the os/posix documentation issue.
1999-02-02 19:02:35 +00:00
dda199b261
Moved \versionadded to end of description sections.
1999-02-02 19:01:37 +00:00
12ba7868e4
Moved posixpath to os.path.
1999-02-02 19:00:37 +00:00
560bcae0f0
Added posixpath, winsound.
1999-02-02 18:59:58 +00:00
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
d0bceeeb59
Move \versionadded macros to end of descriptions.
1999-02-02 18:00:40 +00:00
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
dbd72a4e4f
Added module synopsis.
1999-02-01 21:27:59 +00:00
68a8c69499
Take out just about everything and refer the reader to the os module.
1999-02-01 20:23:02 +00:00
b23ee1d899
Make the text generic, and call it os.path instead of posixpath.
1999-02-01 20:20:39 +00:00
98be47e737
OSError description: "as the by the" --> "as the"
1999-02-01 16:17:40 +00:00
1804dc3c07
Document abspath() (implementation is forthcoming).
1999-01-29 18:05:05 +00:00
703b70e260
Added \modulesynopsis.
1999-01-28 19:30:49 +00:00
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
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
ebe2a12de8
Incorporate changes for patched version of ConfigParser.
1999-01-26 21:49:05 +00:00
bc866ce2e3
Documentation for the ConfigParser module, by Christopher G. Petrilli
...
(petrilli@amber.org ).
1999-01-26 15:47:59 +00:00
9700e9becc
Document the default for tabsize in expandtabs().
1999-01-25 22:31:53 +00:00
19a0dba342
Add caveat on partial dependence on the "cl" module, only available on
...
IRIX systems.
1999-01-20 16:26:09 +00:00
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
a7998f650a
Revised comments on null bytes in pattern string.
...
Removed "New" from module synopsis.
1999-01-19 20:00:08 +00:00
6ffa445832
Fix second description of handling 2-digit years (last item in
...
introductory text).
1999-01-19 19:35:18 +00:00
7eca8e5017
Fix typo spotted by Jeff MacDonald <jam@ans.net>.
1999-01-18 15:46:02 +00:00
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
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
39cddb7439
Added \modulesynopsis.
1999-01-12 19:22:11 +00:00
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
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
c7dd3e11da
Markup nit.
...
Add module synopsis.
1999-01-07 15:45:55 +00:00
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
87e611e441
Replace the docs for reduce with an adaptation of its docstring, which
...
was actually clearer!
1999-01-06 23:10:51 +00:00
74429eacb5
Add doc for access() and ttyname(). Patch by Sean Reifschneider.
1999-01-06 23:03:43 +00:00
c553358c63
Remove documentation for whatraw() since it's gone now.
1999-01-06 15:21:19 +00:00
60adb362df
Document the sndhdr module.
...
Document that the whatsound module is obsolete.
1999-01-05 23:09:12 +00:00
a2e4017394
Shorten the synopsis that gets into the table of contents.
1999-01-05 22:54:49 +00:00
02e18b4b84
Added missing "from" in IOError description.
1999-01-05 21:42:18 +00:00
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
94c4a7976f
Added index entries to make it easier to locate directory & file operations.
1998-12-28 21:58:57 +00:00
8692998018
Added index entries to make it easier to locate directory operations.
1998-12-28 21:58:15 +00:00
76fa3b73d6
Remove recently documented modules from the undoc list.
1998-12-28 20:53:19 +00:00
449e18f459
Add documentation for shutil module.
1998-12-28 20:16:58 +00:00
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
99e2c39b31
Add the getpass module.
1998-12-22 23:37:46 +00:00
5ac2a07fca
Basic documentation for the getpass module.
1998-12-22 23:37:21 +00:00
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
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
1189fa98eb
Adjust markup to match current conventions, and make it formattable.
1998-12-22 18:24:13 +00:00
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
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
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
5e97c9dff9
Adding libshlex and libnetrc by Eric Raymond.
1998-12-22 05:18:24 +00:00
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
3b02ddfa41
Add a bunch of index entries related to retrieving information from
...
the process table.
1998-12-21 18:52:53 +00:00
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
fee6abea90
Remove another {\rm ...} construct.
...
Sheesh, where do these things come from?
1998-12-10 19:57:52 +00:00
e9e05968e3
Nits.
1998-12-10 05:04:21 +00:00
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
aac399b80b
Correct the poplib example. Stephan Richter pointed out some problems
...
with it.
1998-12-08 16:30:10 +00:00
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
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
d83675f344
"singed" --> "signed" (3 places)
...
Noticed by Andrew MacIntyre <andymac@bullseye.apana.org.au>.
1998-12-07 17:13:18 +00:00
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
6d26f4b188
Moved NotImplementedError into alphabetical order, and reword
...
description.
1998-12-01 19:48:04 +00:00
1e151322fb
Added documentation for NotImplementedError. Fred (I'm sure) will
...
sanitize for your protection :-)
1998-12-01 19:19:21 +00:00
2f8592cbea
Ignore the byproducts of SGML/XML conversions for now.
1998-12-01 18:58:28 +00:00
eabfab1048
Nits to support conversions.
1998-12-01 18:37:59 +00:00
1e270f0e03
Nits to support conversions.
1998-11-30 22:58:12 +00:00
50b804dc88
Fix minor nit with respect to conversion.
...
Update some logical markup.
1998-11-30 22:14:58 +00:00
caa3379c4f
Remove {\rm ...} constructs.
1998-11-30 21:53:47 +00:00
84538cd076
Remove some remaining {\rm ...} constructs.
...
Update logical markup in a few spots.
1998-11-30 21:51:25 +00:00
1776556f8f
Markup nit to ease conversions.
1998-11-30 19:00:16 +00:00
3d29955a6e
Markup improvements to help with conversions.
1998-11-30 18:59:44 +00:00
01d5d94020
Remove cruft from the old Texinfo conversion. This simplifies some of
...
the newer processing.
1998-11-30 17:33:38 +00:00
5208823158
Remove bogus \@.
1998-11-30 16:27:37 +00:00
d61975e179
Minor markup nit to ease conversion processing.
1998-11-30 16:26:50 +00:00
f6c59e8fff
Do all the right imports. Problem reported by Martijn Faassen
...
<faassen@vet.uu.nl>.
1998-11-30 15:07:26 +00:00
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
f65e323101
Fix remaining {\rm ...} construct.
1998-11-25 20:55:03 +00:00
5eabf3823b
Clarify that min and max also take multiple arguments.
1998-11-25 18:53:05 +00:00
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
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
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
c46973c89b
Document the user and password parameters to the NNTP constructor.
1998-11-16 17:11:30 +00:00
2510d22048
Clarify the default buffering for open(). (Comment from Andrew Dalke
...
<dalke@bioreason.com>).
1998-11-02 18:57:34 +00:00
cab91efd34
Fix Barry's markup.
1998-11-02 17:23:25 +00:00
9ed1a0afb9
Moved zmod and poly descriptions to the Obsolete section.
1998-11-02 15:46:21 +00:00
4a1cdd7f22
Document the new features of this module
1998-10-31 23:19:00 +00:00
130072d663
Don't describe something as "below"; that won't make sense for the
...
HTML version. Give a reference to the actual section to allow a
hyperlink to be built.
1998-10-28 20:08:35 +00:00
c024c99faf
Fix typo reported by Gerry Weiner <gerry@ucar.edu>.
1998-10-28 18:19:16 +00:00
c1cea208bc
Added URL to HOWTO page, with reference to Regex HOWTO.
...
Corrected error: {,5} is not equivalent to {0,5}.
1998-10-28 15:44:14 +00:00
04101960e6
Indicate that os.environ may not be a real dictionary.
1998-10-24 20:16:56 +00:00
18fa7d2800
Typo: JIFF -> JFIF.
1998-10-19 13:30:01 +00:00
f35b884c91
Clarify that close() of a stream opened by popen() returns None if the
...
exit status is zero.
1998-10-15 13:28:29 +00:00
7d447aabbf
Moved search and match around so that search is documented first.
1998-10-13 16:03:52 +00:00
afd974c2ab
Document the new list.extend() method. Interesting enough, the
...
canonical definition of extend() is very similar to append() except
that the former doesn't list-ify the argument!
1998-10-09 16:39:58 +00:00
09b295754f
Remove extra } at end of method description parameters.
1998-10-01 20:43:13 +00:00
b2031f72d3
Document that apply() can now take any sequence in argument 2.
1998-10-01 15:35:43 +00:00
9814a943a5
Add warning that on Windows it only works on sockets.
1998-09-28 14:28:38 +00:00
954b9adcd2
Document new urllib features by Eric Raymond.
1998-09-28 14:08:29 +00:00
5fb2631ff9
Explicitly document the fact that the search method returns a MatchObject.
...
(Reported by Gary Herron.)
1998-09-21 19:26:16 +00:00
Fred Drake
Barry Warsaw
Guido van Rossum
Andrew M. Kuchling