Commit Graph

48 Commits

Author SHA1 Message Date
Georg Brandl ae91afdcfb Lots of explicit class names for method and member descs. 2007-04-01 22:39:10 +00:00
Collin Winter b7b2b4eecf Bug #1629566: clarify the docs on the return values of parsedate() and parsedate_tz() in email.utils and rfc822. 2007-03-09 18:09:10 +00:00
Raymond Hettinger 68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Raymond Hettinger 999b57c872 Fix double word typos. 2003-08-25 04:28:05 +00:00
Fred Drake 853276e16d Lots of markup cleanups to avoid warnings from the GNU info generation;
these make sense even without that processing chain.
2003-07-16 17:58:38 +00:00
Fred Drake aa02c8441b Accept Armin's documentation patch for SF bug #558179.
Adjusted some markup to make the descriptions more consistent.
2002-10-09 22:33:23 +00:00
Fred Drake 4613876ee3 Add deprecation notices to the documentation to reflect recent additions to
PEP 4.
2002-09-25 22:13:27 +00:00
Fred Drake 2d3c03df9a Added references to the email package.
Closes SF bug #586937.
2002-08-06 21:26:01 +00:00
Neal Norwitz 6b35370c65 Update docs for bool changes by Guido around April 6 2002-04-09 18:15:00 +00:00
Fred Drake d93d68bd13 Fix minor typo reported in SF patch #497951. 2002-01-05 01:52:41 +00:00
Fred Drake f5072b9314 Document the "unixfrom" attribute of the rfc822.Message class.
Based on a patch by Skip Montanaro, this closes SF bug #458885.
2001-09-06 15:07:55 +00:00
Fred Drake d86038d1be Apply the new \mailheader macro where appropriate, and fix a few small
markup inconsistencies.
2001-08-03 18:39:36 +00:00
Fred Drake e78661bf90 Fix a couple of minor markup nits.
Footnotes should be added *after* punctuation, not before.
(Yes, this should be merged with the descr branch.  Sorry, Tim!)
2001-07-17 05:17:58 +00:00
Barry Warsaw 95400a28e4 Updated the documentation in several respects:
- This module, despite its name, now should conform to RFC 2822, the
  update to RFC 822.

- This module doesn't just represent "email headers", but entire email
  messages.

- Added documentation for other useful public functions such as
  quote(), unquote(), praseaddr(), and dump_address_pair().
2001-07-16 20:47:58 +00:00
Fred Drake 98cfab6523 One more update related to the new get() and setdefault() methods on the
Message object.
2001-05-22 22:00:40 +00:00
Fred Drake 6b4593e338 Update to add get() and setdefault() as supported mapping operations, and
add a list of the mapping methods which are not supported (per Barry's
comments).
2001-05-22 15:12:46 +00:00
Fred Drake 706314909b Add some clarifications about the mapping interface presented by
rfc822.Message objects, based on comments from Barry.
2001-05-22 14:36:30 +00:00
Fred Drake 9c846366ee Fix a number of bugs and omissions in the AddressList documentation, most
noted by Steve Holden.


This closes SF bug #413876.
2001-04-09 15:42:56 +00:00
Eric S. Raymond e7213c7a80 Emphasis that instantiating this class doesn't consume the message body.
Fix some unclear language in the description of the addrlist member.
2001-01-27 10:56:14 +00:00
Skip Montanaro 6634b14f3b add cross reference to mimetools module 2000-09-15 18:20:20 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake ae0f292576 Fix typo reported by Robert Kern <kernr@ncifcrf.gov>. 1999-06-10 15:03:07 +00:00
Fred Drake ea0020571f Use \rfc to mark some remaining RFC references.
Remove comment about full name bug in getaddrlist(); this has been
fixed for a while now.

Work around LaTeX2HTML space-dropping bug.

Mention that the fp attribute can be used to read the message body.
1999-04-28 18:11:09 +00:00
Fred Drake ffbe68723a Make internal module references hyperlinks wherever it makes sense. 1999-04-22 21:23:22 +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 295da24eaf New section header style.
Fix up a few synopses.
1998-08-10 19:42:37 +00:00
Fred Drake 23329d41bc Some logical markup, some nits. 1998-08-10 17:46:22 +00:00
Fred Drake b91e934cf1 Adjusted to use the new module synopsis support macros. 1998-07-23 17:59:49 +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 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
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 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 cdea8a3c60 Logical markup.
Wrap general Message class description in a {classdesc} instead of nothing at
all.
1998-03-14 06:17:43 +00:00
Guido van Rossum a73033fcc2 Feature added by Bill van Melle: when no timezone is present, assume
local time -- that's better than failure.
1998-02-19 00:28:58 +00:00
Guido van Rossum 026d9626df Consistent spelling: "time zone" -> "timezone".
Clarify that the sign of the timezone offset returned by
parsedate_tz() is the opposite of time.timezone.
1998-02-18 21:47:29 +00:00
Guido van Rossum 8cf94e608e Add mktime_tz(). Add () to a function reference in parsedate_tz(). 1998-02-18 05:09:14 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
1998-02-13 06:58:54 +00:00
Fred Drake c58912426e Use the new RFC macros wherever RFCs are referenced by number. No other
changes.
1998-02-09 19:16:20 +00:00
Fred Drake 5ca9033062 Index the RFC822 reference (some other RFC references were alreaddy indexed).
Add index reference to mailbox module; also remove comment that it's
undocumented (it has been).
1997-12-16 15:19:47 +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 067a2acdf6 Mention seekable parameter (AMK).
Added pointer to mailbox module.
1997-06-02 17:30:03 +00:00
Guido van Rossum 843e712bda Added descriptions of parsedate(), parsedate_tz(), getdate_tz()
(all contributed by Andrew Kuchling).
1996-12-06 21:23:53 +00:00
Guido van Rossum ecde781dd1 restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
Guido van Rossum 470be14c8a mass changes; fix titles; add examples; correct typos; clarifications;
unified style; etc.
1995-03-17 16:07:09 +00:00
Guido van Rossum 6c4f003202 changes (suggested) by Soren Larsen 1995-03-07 10:14:09 +00:00
Guido van Rossum 8675115e5f a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter 1995-02-28 17:14:32 +00:00
Guido van Rossum a12ef9433b added WWW sections 1995-02-27 17:53:25 +00:00