Commit Graph

957 Commits

Author SHA1 Message Date
Andrew M. Kuchling 16440e63be Added libthreading.tex ; this is mostly the contents of threading_api.py,
with LaTeX markup added, and some small rewrites to improve the prose.
1998-07-20 13:46:10 +00:00
Guido van Rossum dfba2fbfd0 Eric Raymond documents two already-existing functions (bmp, png). 1998-07-17 19:01:29 +00:00
Guido van Rossum 7bda89f694 Rewritten a bit to address some criticism in the newsgroup. 1998-07-06 20:47:40 +00:00
Fred Drake 1717ba498f Normalize markup. 1998-07-02 19:36:50 +00:00
Fred Drake 579d366458 Normalize the markup. 1998-07-02 19:35:12 +00:00
Fred Drake 3f6034dcce Added index entry. 1998-07-02 19:33:43 +00:00
Fred Drake 91e5211bbf Added \deprecated to exit_thread() function.
Reflects Guido's revision.
1998-07-02 19:33:12 +00:00
Fred Drake 3240dd2bc2 Mark the actual SMTP commands (HELO, etc.) the same way FTP & NNTP commands
are in the appropriate sections.

Some minor nits.
1998-07-01 14:10:52 +00:00
Guido van Rossum cf51dacfb8 Document __copy__() and __deepcopy__() methods. 1998-06-30 16:54:33 +00:00
Fred Drake 5b68362a3a Use the real name of the module: "smtplib", not "smtp".
Use logical (& consistent) markup.

Added a see-also section at the end.
1998-06-30 16:53:52 +00:00
Guido van Rossum 8ec619f60e Note that readline returns '' on EOF, not "EOF" (whatever that may be). 1998-06-30 16:35:25 +00:00
Guido van Rossum 472b9a3f06 Clearly I was to quick with the previous commit...
Need to add \optional{} to sort argument too.

Made x a \var in descr of pop.

Fixed note for pop() and mentioned that it is experimental.

Also added pop to index.
1998-06-30 16:02:35 +00:00
Guido van Rossum 97ea116472 Documented the pop() method for lists.
# The brackets generated by \optional{} are real ugly.  Alas...
1998-06-30 15:56:23 +00:00
Guido van Rossum 9c59ce9b5a Documented os.linesep (line separator). 1998-06-30 15:54:27 +00:00
Guido van Rossum cd90509d58 As suggested by pson@pson.pp.se, correct the docs for head(), body(),
article().
1998-06-30 14:53:41 +00:00
Andrew M. Kuchling 52a79e8e1c Changed URL to crypto page. 1998-06-30 13:42:05 +00:00
Guido van Rossum 6c373f758f Document new default arg to groups() and new functions/methods
groupdict() and findall().
1998-06-29 22:48:01 +00:00
Guido van Rossum f9cfb173cd Now cmd is documented too. 1998-06-28 18:01:59 +00:00
Guido van Rossum a40d643cdc Documented smtplib, multifile 1998-06-28 17:58:06 +00:00
Guido van Rossum 8ddbe9119f Documented cmd, smtplib, multifile 1998-06-28 17:57:27 +00:00
Guido van Rossum 8668e8e49c Contributions by Eric Raymond: documentation for modules
cmd, multifile and smtplib.
1998-06-28 17:55:53 +00:00
Guido van Rossum 73d8bff44d Document optional kwargs argument to start_new_thread(). Also
document new LockType and reverse the preference for exit()
vs. exit_thread() -- exit() is now preferred and exit_thread() is
obsolete.
1998-06-27 18:25:44 +00:00
Fred Drake e5836d9811 Mark the 'whence' parameter of the file object's seek() method as optional;
it's already decribed that way in the description.
1998-06-25 16:26:56 +00:00
Andrew M. Kuchling 65b7863efc Fix unclear wording pointed out by Tim Peters, about the interaction between
^ and the pos argument to re.match().
Also, fixed a typo in libregex.tex.
1998-06-22 15:02:42 +00:00
Guido van Rossum a7874d1505 Revert the change of revision 1.30. While it's in general a laudable
goal to use isinstance(x, y) instead of comparing type(x) to y, it
doesn't make sense to change this in the example code for the type()
builtin...
1998-06-22 14:07:36 +00:00
Fred Drake 1b0ff2c32f eval() example: Removed final interpreter prompt; other examples don't have
the empty prompt.
1998-06-19 21:19:50 +00:00
Fred Drake 59160706b3 Somewhat updated, but not checked for everything (just the stuff I was using). 1998-06-19 21:18:28 +00:00
Guido van Rossum 7b7f6688d2 Added a stronger warning about changing the dictionary returned by
locals().
1998-06-18 16:45:34 +00:00
Guido van Rossum faac0136f4 # Untabified the example :-( 1998-06-17 22:38:09 +00:00
Guido van Rossum bca1207ac8 Documented that by default the output goes to stderr, and that a file
keyword argument can be used to direct it somewhere else.  Also
documented all the other functions in this module, and even added a
little example.

# Haven't tested the latex for correctness -- all latex installations
# appear broken.
1998-06-17 22:37:26 +00:00
Guido van Rossum 777dcc6b21 Change the description of input() -- it is exactly equivalent to
eval(raw_input(s)).  The statement about breaking a long expression
over multiple lines is no longer true.
1998-06-17 15:16:40 +00:00
Guido van Rossum 872948350f Some extra notes, and describe a new class (AddressList), all by ESR. 1998-06-16 22:27:40 +00:00
Guido van Rossum a3eebe60dc Add warning about use of lowercase/uppercase with maketrans(). 1998-06-11 16:03:30 +00:00
Guido van Rossum 444d0f87c9 Eric Raymond: added doc for isheader(); improved docs for constructor. 1998-06-11 13:50:02 +00:00
Guido van Rossum 1299100324 Document the changes I just checked in. 1998-06-10 21:34:27 +00:00
Guido van Rossum 3e5fe422cc Document several variables that were previously undocumented,
including the new __stdin__, __stdout__ and __stderr__.
Also moved setttrace around to its proper place in the alphabet.
1998-06-10 17:57:44 +00:00
Guido van Rossum 929bd0e02e Added notes about epochs, the year 2038, and a small Y2K disclaimer
(all with index entries!).  Also update the list of functions that
take or yield a time represented as a 9-tuple.
1998-06-09 21:25:41 +00:00
Guido van Rossum 5d23758be7 Added docs for strptime(). 1998-06-09 16:30:56 +00:00
Guido van Rossum 52481484e6 Clarify the type of the signal handler. 1998-06-09 15:42:25 +00:00
Guido van Rossum a58e9edbef Document missing functions: xor, not, truth, countOf, indexOf, and
(new!) contains.
1998-05-22 18:48:37 +00:00
Fred Drake 6a50ba82ce Minor grammatical correction: "This module perform ..." --> "This module
performs ...".
1998-05-22 18:19:19 +00:00
Fred Drake 7c68ab2f2b Added entry for mimetypes. 1998-05-19 19:13:01 +00:00
Fred Drake b818b46b38 Add section documenting mimetypes module. 1998-05-19 15:03:45 +00:00
Fred Drake 203b4f1a25 Add an index entry.
Bow to font lock.
1998-05-14 15:16:12 +00:00
Fred Drake a4c640e142 Reverted the last change; the extra cruft is harmless for formatted versions,
and allows the info to work through this section.
1998-05-11 19:51:11 +00:00
Fred Drake 02379fab61 Use \ldots, not \dots. The info process doesn't know about \dots. 1998-05-08 15:39:40 +00:00
Guido van Rossum 7b0c9d8a07 exec is a statement, not a function! 1998-05-08 13:27:38 +00:00
Fred Drake 4775d0a353 Relocating file to mac. 1998-05-07 12:58:57 +00:00
Fred Drake f7ffa92ce3 Fix typo in example found by Anthony Starks <anthony_starks@merck.com>,
reported to me by Piers Lauder <piers@cs.su.oz.au>.
1998-05-06 12:42:37 +00:00
Fred Drake 91eeefdee4 Work around lack of support for \if... in latex2html. 1998-04-29 17:56:44 +00:00
Fred Drake 06245ac2fa Fix documentation based on comments from Sean Reifschneider
<jafo-9804@tummy.com>.

Logical markup.
1998-04-29 14:38:34 +00:00
Fred Drake b5aa3de118 Remove extra cruft for texi processing. 1998-04-28 18:37:12 +00:00
Fred Drake ca6b4fe36b Section for bisect module. 1998-04-28 18:28:21 +00:00
Fred Drake 188a8471b8 Moved popen2 entry to make more sense.
Added bisect entry.
1998-04-28 18:27:53 +00:00
Fred Drake 125024a87d Updated. 1998-04-28 18:27:22 +00:00
Guido van Rossum 2aefe8d7c0 Document changed semantics -- open() now guesses the db type and error
is now a tuple of various and sundry exceptions.
1998-04-28 15:29:26 +00:00
Fred Drake f8d50bfdb0 Hook in the calendar and popen2 sections. 1998-04-28 14:29:27 +00:00
Fred Drake 1c127e74af calendar module section for the library reference, by Drew Csillag. 1998-04-28 14:28:57 +00:00
Fred Drake 6afad3792d popen2 section for the library reference, contributed by Drew Csillag, with
some reorganization.
1998-04-28 14:28:15 +00:00
Fred Drake 2a1cc3e171 Use of \key and \kbd were isolated to one instance each in this file;
normalize to \kbd to allow removal of \key from the document class.
1998-04-28 13:38:54 +00:00
Fred Drake 4f31694d37 Document transfercmd(), ntransfercmd(), delete(), rmd(), size().
Thanks to Timothy Wild <twild@clear.net.nz> for catching the omission of
delete().
1998-04-27 14:54:06 +00:00
Fred Drake a468404dda Added a section for the poplib module, contributed by Drew Csillag. 1998-04-24 20:49:02 +00:00
Fred Drake e28fb67c2c Add entry for poplib. 1998-04-24 20:08:28 +00:00
Fred Drake 42de185a77 Added \label to subsections which didn't have one, since this module has
subsections listed in the documentation index sidebar.  (Why?)
1998-04-20 16:28:44 +00:00
Guido van Rossum a933f6a53d Fix vonmisesvariate() -- it now returns an angle between 0 and *two*
times pi.  Got rid of $math$ here and in one other place.
1998-04-20 14:43:44 +00:00
Fred Drake 4f5155817b Mark TMPDIR correctly. 1998-04-17 14:51:04 +00:00
Fred Drake 1d9fb63293 Remove commented-out Mac chapter. 1998-04-17 13:24:55 +00:00
Fred Drake 6b303b4bdd Signature for dir() omitted the optional argument. 1998-04-16 22:10:27 +00:00
Fred Drake 12d9fc94f4 Use shorter labels; using long labels creates problems on the Macintosh.
(Thanks, Just!)
1998-04-14 17:19:54 +00:00
Fred Drake 95638f5b0f Added entry for Tkdnd.py. 1998-04-14 04:55:43 +00:00
Fred Drake 68fede768a Added item in Misc. for getpass module. 1998-04-13 20:31:31 +00:00
Fred Drake 916d8f8733 No more threats, just list the new methods under "AST Objects". 1998-04-13 18:46:16 +00:00
Fred Drake c4f1ca1967 Add a note that pickling is supported. 1998-04-13 16:27:27 +00:00
Fred Drake 3e7a48e0d9 Revert markup around list of display fields from the disassembler; it doesn't
look at good in print, but doesn't break the HTML.
1998-04-13 16:15:02 +00:00
Fred Drake 6250205166 Use {methoddesc} instead of {funcdesc} for object methods. 1998-04-12 03:31:31 +00:00
Fred Drake 898601bf8f Add cPickle to the list of modules in the chapter. 1998-04-12 03:08:41 +00:00
Fred Drake d6d88ffaf9 Add cStringIO to the list of modules in the chapter. 1998-04-12 03:07:35 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 17e564042d Change order of \seemodule macros at end of pickle module section. 1998-04-11 20:43:51 +00:00
Fred Drake 9463de2092 Document cPickle and cStringIO. 1998-04-11 20:05:43 +00:00
Fred Drake fab2f34538 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 18:46:56 +00:00
Fred Drake 7e9383ab59 Add a comment to indicate the methods of the StringIO are being discussed... 1998-04-11 18:05:24 +00:00
Fred Drake 70c460c84d Remove imaplib from the undocumented list. 1998-04-11 16:58:26 +00:00
Fred Drake a38a2867d0 Include () after function name.
One more logical mark.
1998-04-11 16:57:05 +00:00
Fred Drake 0d213d3497 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 16:40:46 +00:00
Fred Drake 34672dbb38 Remove over-active replace-string turds. 1998-04-11 16:24:21 +00:00
Fred Drake 8f6b958fdb Use {memberdesc} to mark the instance attributes. 1998-04-11 15:11:55 +00:00
Fred Drake 7dba8e2ab4 Hmmm... better add some \label macros for logical addressing while I'm at it. 1998-04-11 13:51:05 +00:00
Fred Drake 2a37455967 It's "Lauder", not "Lauders"! 1998-04-11 13:48:26 +00:00
Fred Drake e5cf53ad89 Formatting nits.
An index entry.
1998-04-11 05:02:45 +00:00
Fred Drake eb4ed15be8 Shift index entries around a little so the HTML doesn't have weird spacing. 1998-04-11 04:52:15 +00:00
Fred Drake 1e0f8bfea9 Add imaplib to appropriate lists. 1998-04-11 04:27:07 +00:00
Fred Drake 36751b0ed2 Remove obsolete module soundex from list of modules. 1998-04-11 04:23:07 +00:00
Fred Drake c48b772a77 Remove obsolete module rand from list of modules.
Add fileinput to list.
1998-04-11 04:22:02 +00:00
Fred Drake 89de314cfc First cut at documentation for imaplib. Based on original documentation by
Piers Lauders.
1998-04-11 04:19:04 +00:00
Fred Drake 007bac3b0b Added smtplib.py (thanks, Guido!). 1998-04-09 18:54:01 +00:00
Fred Drake 2cb824cbf9 Don't use \samp when \code is better.
Consistently use ' instead of ":  this conforms to my unofficial stance that
constants should be presented using the repr() whenever it makes sense.  This
isn't because I think repr() is the greatest thing since spam, just that it's
an easy to adopt consistency standard.  (It also holds no new surprises!)
1998-04-09 18:10:35 +00:00
Fred Drake 45c634ecae Work around a small (& annoying) limitation of the latex2html support for
\seemodule.  This is far easier than figuring out the real problem, but it
works.
1998-04-09 15:44:58 +00:00
Fred Drake 8a254b5967 Removed misleading comment about GNU software. This module and the zlib
library have no relationship with GNU software other than implementing some of
the same algorithms and file format.  (The zlib module is more general.)
1998-04-09 15:41:44 +00:00
Andrew M. Kuchling 253328104f Many markup changes (to \regexp, mostly)
Clarified text on 8-bit cleanness, complemented sets like [^5], and {m,n}
  qualifier.
1998-04-09 14:56:04 +00:00
Fred Drake 20ca9171c1 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).

Add section for previously documented obsolete modules.  Includes ni, rand,
and soundex.
1998-04-09 14:32:28 +00:00
Fred Drake 363ab1a613 Comment out the soundex section. 1998-04-09 14:23:48 +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 9da38814a3 Use the correct URL to AMK's regex-to-re HOWTO! 1998-04-09 14:06:33 +00:00
Fred Drake 54c3947fbc Updated URL to AMK's regex-to-re HOWTO. 1998-04-09 14:03:00 +00:00
Fred Drake 5406e7071f Added reference to AMK's HOWTO on the topic. 1998-04-09 14:02:02 +00:00
Fred Drake 223395c0a0 Added imaplib. 1998-04-09 13:55:06 +00:00
Fred Drake b8efda01e6 Update URL to the related HOWTO document. 1998-04-09 13:49:18 +00:00
Fred Drake bd400881dd Add section for ni back in, but comment it out. 1998-04-09 11:04:19 +00:00
Fred Drake eac469ca3d Commented out sections on obsolete & Macintosh modules. 1998-04-09 04:51:07 +00:00
Fred Drake f1b72ddf82 Reduced description of the obsolete method Stats.ignore(). 1998-04-09 04:49:56 +00:00
Guido van Rossum ae2be7144d Correct definition of CTIME. 1998-04-08 22:44:25 +00:00
Fred Drake 2764dd33cf Separate sections on anydbm and dumbdbm.
This is the last separation; each module now gets its own section.  This will
be useful in performing conversions.
1998-04-07 22:08:02 +00:00
Fred Drake 8e729ec31a Caught a few more spurious \setindexsubitem macros.... 1998-04-07 22:06:41 +00:00
Fred Drake a3f5c32f18 Removed unnecessary \setindexsubitem. 1998-04-07 21:45:52 +00:00
Fred Drake 1ce3604cfd Separate UserDict and UserList documentation into separate sections. 1998-04-07 20:05:33 +00:00
Fred Drake c708605f4f Added a reference to the discussion in Knuth's "Sorting and Searching", and
noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
1998-04-07 19:58:19 +00:00
Fred Drake 396b827a93 Minor markup nit. 1998-04-07 19:17:27 +00:00
Fred Drake 82d493fb96 Fixed some index entries. 1998-04-07 19:14:17 +00:00
Fred Drake 6b9ff7257b Added entry for wdb. 1998-04-07 19:09:32 +00:00
Fred Drake 810349b685 Fix the formatting of the list of fields in the disassemble() function. 1998-04-07 14:16:41 +00:00
Fred Drake 272fb3aaa4 Added poplib.
Made the module lists look like the other module lists in the documentation.
1998-04-07 14:15:28 +00:00
Fred Drake af370ea254 Move a short paragraph outside the description of ASTType. 1998-04-05 20:23:02 +00:00
Fred Drake 3a0351cf85 Remove all uses of \sectcode; we can now use logical markup everywhere. 1998-04-04 07:23:21 +00:00
Fred Drake fc57619811 Remove obsolete \setindexsubitem macros.
Massive migration to methoddesc and memberdesc.

Logical markup as needed.

A sprinkling of index entries for flavor.
1998-04-04 07:15:02 +00:00
Fred Drake 71c1e502f0 Moved some things around.
Adjusted a couple of the comments to be more informative.

Tell a little bit about what obsolete means now, and how to use obsolete
modules.
1998-04-04 07:03:19 +00:00
Fred Drake 13beac1289 Removed obsolete \setindexsubitem macros. 1998-04-04 06:46:51 +00:00
Fred Drake 85ea68b2a2 Added index entries. 1998-04-04 06:46:05 +00:00
Fred Drake 81acc2e988 Remove obsolete \setindexsubitem macro.
Logical markup, methoddesc, etc.
1998-04-04 06:35:41 +00:00
Fred Drake 61f45c7cb5 Remove obsolete \setindexsubitem macro,
Added index entries.

Markup nits.
1998-04-04 06:31:51 +00:00
Fred Drake b208f128b4 Added index entry. 1998-04-04 06:28:54 +00:00
Fred Drake 82143348aa Remove obsolete \setindexsubitem macro. 1998-04-04 06:28:14 +00:00
Fred Drake 858f787a02 Fix index entry for HTMLParser class. 1998-04-04 06:25:27 +00:00
Fred Drake 41788db3e2 Logical markup.
Index entries.
1998-04-04 06:23:02 +00:00
Fred Drake 9b28fe285d Logical markup. 1998-04-04 06:20:28 +00:00
Fred Drake e14dde2117 Fixed description of similarity between m[name] and m.getheader(name),
reported by Samuel L. Bayer.

Use methoddesc instead of funcdesc, etc.
1998-04-04 06:19:30 +00:00
Fred Drake d275de985a Remove obsolete lines like this:
\setindexsubitem{(in module frobnitz)}

These are no longer needed when present before any other \setindexsubitem{}
in the module section.  The indexsubitem is now set by \bimodindex and
\stmodindex.
1998-04-04 05:56:51 +00:00
Fred Drake 4bde97f190 Add fileinput section under Misc. Services. 1998-04-04 05:50:12 +00:00
Fred Drake 35ca0d69e1 Document fileinput. 1998-04-04 04:20:51 +00:00
Fred Drake 07bcd99873 Start at updating the template a little bit. There's a lot of stuff that's
just not here yet.
1998-04-03 21:25:16 +00:00
Guido van Rossum 791468f731 Some clarifications of out-of-range group indexes/names 1998-04-03 20:07:37 +00:00
Fred Drake 61885924b1 Lots of markup consistency nits.
Logical markup.
1998-04-03 07:16:46 +00:00
Fred Drake 6251c169c6 Small nits.
One more index entry.

Be more specific about an exception raised by range().
1998-04-03 07:15:54 +00:00
Fred Drake 8efde2197b Several minor markup nits. 1998-04-03 07:13:56 +00:00
Fred Drake 9f6aec870e "alternative" is a noun, use "alternate" for the adjective.
Minor nits.
1998-04-03 07:12:52 +00:00
Fred Drake 14c198b146 Talk about some minor nits... 1998-04-03 07:11:32 +00:00
Fred Drake 395e8e4860 Capitalize "Python" for consistency.
Describe UserDict and UserList individually so they aren't too hideous in
the presentation.
1998-04-03 07:10:41 +00:00
Fred Drake 7932a6bf8c Small markup nits. 1998-04-03 07:09:38 +00:00
Fred Drake d59db4f974 Small consistency nits. 1998-04-03 07:06:56 +00:00
Fred Drake 2123774287 Capitalize "Python" for consistency. 1998-04-03 07:06:01 +00:00