Commit Graph

56 Commits

Author SHA1 Message Date
Serhiy Storchaka 138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
Charles-Axel Dein e394ba3214 bpo-35404: Clarify how to import _structure in email.message doc (GH-10886) 2019-01-09 15:52:10 -07:00
Andre Delfino 55f41e45b4 Correct a couple of unbalanced parenthesis. (GH-10779) 2018-12-05 21:45:30 +02:00
Serhiy Storchaka 3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231) 2018-10-31 02:26:06 +02:00
delirious-lettuce 3378b2062c Fix typos in multiple `.rst` files (#1668) 2017-05-19 23:37:57 +03:00
Alex Gaynor 1cf2a809b1 Fixed a handful of typos (GH-343) 2017-02-28 19:26:56 -08:00
Martin Panter cf01441315 Fix typos in documentation 2016-11-20 08:37:21 +00:00
R David Murray 7f730cf01d 24277: Make it clearer that the new modules are not provisional.
Also make it clear on the contents page what chapters are about the
legacy API.
2016-09-08 18:28:43 -04:00
R David Murray 29d1bc0842 #24277: The new email API is no longer provisional.
This is a wholesale reorganization and editing of the email documentation to
make the new API the standard one, and the old API the 'legacy' one.  The
default is still the compat32 policy, for backward compatibility.  We will
change that eventually.
2016-09-07 21:15:59 -04:00
Zachary Ware 640b1ca507 Issue #27209: Fix doctests in Doc/library/email*.rst
Patch by Jelle Zijlstra.
2016-08-10 00:39:41 -05:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
R David Murray b744f3a45e #21083: add get_content_disposition method to email.message.
Patch by Abhilash Raj.
2015-05-16 15:41:07 -04:00
R David Murray 9cc5fd7b59 #18854: make it explicit that is_multipart does not mean 'multipart/xxx'.
Original patch (and the idea of using _structure) by Abhilash Raj.
2014-09-27 15:37:40 -04:00
R David Murray a83ade1d60 #21300: fix typo 2014-05-08 10:05:47 -04:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
R David Murray 27e9de669b #20531: Revert e20f98a8ed71, the 3.4 version of the #19063 fix. 2014-02-07 12:40:37 -05:00
R David Murray 50bfbb9903 #19063: fix set_payload handling of non-ASCII string input.
This version of the fix raises an error instead of accepting the invalid
input (ie: if a non-ASCII string is used but no charset is specified).
2013-12-11 16:52:11 -05:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Georg Brandl ed007d5b1b Fix suspicious markup in the docs. 2013-11-24 16:09:26 +01:00
R David Murray 3da240fd01 #18891: Complete new provisional email API.
This adds EmailMessage and, MIMEPart subclasses of Message
with new API methods, and a ContentManager class used by
the new methods.  Also a new policy setting, content_manager.

Patch was reviewed by Stephen J. Turnbull and Serhiy Storchaka,
and reflects their feedback.

I will ideally add some examples of using the new API to the
documentation before the final release.
2013-10-16 22:48:40 -04:00
Serhiy Storchaka 319f3a10f9 Issue #18761: Improved cross-references in email documentation. 2013-08-19 10:03:11 +03:00
Serhiy Storchaka e0f0cf4067 Issue #18761: Improved cross-references in email documentation. 2013-08-19 09:59:18 +03:00
R David Murray fb1a7bc907 #18600: In 3.3, as_string does not accept a policy keyword.
Also, document the policy keyword that was added to Message in 3.3.
2013-08-09 16:17:00 -04:00
R David Murray bb17d2b857 #18600: add policy to add_string, and as_bytes and __bytes__ methods.
This was triggered by wanting to make the doctest in email.policy.rst pass;
as_bytes and __bytes__ are clearly useful now that we have BytesGenerator.
Also updated the Message docs to document the policy keyword that was
added in 3.3.
2013-08-09 16:15:28 -04:00
R David Murray fdfb0050bb #18584: make doctest examples in email documentation pass.
With the exception of the 'as_string' call in the policy docs.
That one is a separate issue.

Note that when building the docs sphinx is complaining about
.. testcleanup:: being an invalid directive.  I don't know
why this is, as I'm following the sphinx docs...but fortunately
the action is to omit the text in the body, so the generated
documentation is correct.
2013-07-29 15:49:58 -04:00
R David Murray 80e0aee95b #1672568: email now registers defects for base64 payload format errors.
Which also means that it is now producing *something* for any base64
payload, which is what leads to the couple of older test changes in
test_email.  This is a slightly backward incompatible behavior change,
but the new behavior is so much more useful than the old (you can now
*reliably* detect errors, and any program that was detecting errors by
sniffing for a base64 return from get_payload(decode=True) and then doing
its own error-recovery decode will just get the error-recovery decode
right away).  So this seems to me to be worth the small risk inherent
in this behavior change.

This patch also refactors the defect tests into a separate test file,
since they are no longer just parser tests.
2012-05-27 21:23:34 -04:00
R David Murray 79cf3bad1b #11785: fix the :mod: references in email package submodule titles.
Also adds the TOC entry for headerregistry.
2012-05-27 17:10:36 -04:00
Ezio Melotti e130a52d8a Remove duplication. 2011-10-19 10:58:56 +03:00
R David Murray 729c5e203d Merge #11216: document all possible set_charset execution paths. 2011-03-15 17:42:50 -04:00
R David Murray e3d09ff269 #11216: document all possible set_charset execution paths. 2011-03-15 17:41:13 -04:00
R David Murray 4a0b60c527 Merge #11555 as_string doc fix from 3.1. 2011-03-15 14:02:53 -04:00
R David Murray 7dedcb4644 #11555: update doc for 3.x change to as_string mangle_from default. 2011-03-15 14:01:18 -04:00
R David Murray c48c19afe0 Merge redundant __contains__ doc fix from 3.1. 2011-03-14 22:53:29 -04:00
R David Murray f6db0bbbee Remove redundant __contains__ entry from Message docs. 2011-03-14 22:43:38 -04:00
R. David Murray 9253214fd9 #10686: recode non-ASCII headers to 'unknown-8bit' instead of ?s.
This applies only when generating strings from non-RFC compliant binary
input; it makes the existing recoding behavior more consistent (ie:
now no data is lost when recoding).
2011-01-07 23:25:30 +00:00
Georg Brandl c88435023c Fix markup error and update suspicious file. 2010-12-19 10:28:46 +00:00
R. David Murray ccb9d05b6c Merged revisions 87217 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r87217 | r.david.murray | 2010-12-13 18:51:19 -0500 (Mon, 13 Dec 2010) | 5 lines

  #1078919: make add_header automatically do RFC2231 encoding when needed.

  Also document the use of three-tuples if control of the charset
  and language is desired.
........
2010-12-13 23:57:01 +00:00
R. David Murray 7ec754b7da #1078919: make add_header automatically do RFC2231 encoding when needed.
Also document the use of three-tuples if control of the charset
and language is desired.
2010-12-13 23:51:19 +00:00
Senthil Kumaran 8227045bbe Fix sphinx role markups. 2010-10-15 13:29:33 +00:00
R. David Murray 96fd54eaec #4661: add bytes parsing and generation to email (email version bump to 5.1.0)
The work on this is not 100% complete, but everything is present to
allow real-world testing of the code.  The only remaining major todo
item is to (hopefully!) enhance the handling of non-ASCII bytes in headers
converted to unicode by RFC2047 encoding them rather than replacing them with
'?'s.
2010-10-08 15:55:28 +00:00
R. David Murray 9fc20536a4 Merged revisions 78657 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r78657 | r.david.murray | 2010-03-04 12:38:18 -0500 (Thu, 04 Mar 2010) | 10 lines

  Merged revisions 78656 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r78656 | r.david.murray | 2010-03-04 12:34:05 -0500 (Thu, 04 Mar 2010) | 3 lines

    Fix documentation of email.Message.get_filename to match
    the fix applied in Issue 7082.
  ........
................
2010-03-04 17:43:40 +00:00
R. David Murray 9ed34bea3e Merged revisions 78656 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78656 | r.david.murray | 2010-03-04 12:34:05 -0500 (Thu, 04 Mar 2010) | 3 lines

  Fix documentation of email.Message.get_filename to match
  the fix applied in Issue 7082.
........
2010-03-04 17:38:18 +00:00
R. David Murray 27e48ef369 Merged revisions 77417 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r77417 | r.david.murray | 2010-01-10 14:18:27 -0500 (Sun, 10 Jan 2010) | 10 lines

  Merged revisions 77412 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r77412 | r.david.murray | 2010-01-10 12:41:28 -0500 (Sun, 10 Jan 2010) | 3 lines

    Issue #7119: document that a program-generated Message object
    tree may be mutated when serialized.
  ........
................
2010-01-10 19:21:20 +00:00
R. David Murray 101f27805c Merged revisions 77412 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77412 | r.david.murray | 2010-01-10 12:41:28 -0500 (Sun, 10 Jan 2010) | 3 lines

  Issue #7119: document that a program-generated Message object
  tree may be mutated when serialized.
........
2010-01-10 19:18:27 +00:00
Georg Brandl 3f076d8b3d Use new optional argument style in email docs. 2009-05-17 11:28:33 +00:00
Georg Brandl 3638e487b9 Merged revisions 71572 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r71572 | georg.brandl | 2009-04-13 15:13:25 +0200 (Mo, 13 Apr 2009) | 1 line

  #5745: more linking for identifiers in email docs.
........
2009-04-27 16:46:17 +00:00
Georg Brandl 540b45c475 Merged revisions 71544,71546,71554-71555 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r71544 | benjamin.peterson | 2009-04-13 01:19:56 +0200 (Mo, 13 Apr 2009) | 1 line

  fix extra parenthesis #5774
........
  r71546 | benjamin.peterson | 2009-04-13 01:44:15 +0200 (Mo, 13 Apr 2009) | 1 line

  fix missing quote
........
  r71554 | hirokazu.yamamoto | 2009-04-13 03:07:06 +0200 (Mo, 13 Apr 2009) | 1 line

  Fixed typo. (email.Utils => email.utils)
........
  r71555 | hirokazu.yamamoto | 2009-04-13 03:21:56 +0200 (Mo, 13 Apr 2009) | 1 line

  Fixed another typos. (email.Utils => email.utils)
........
2009-04-27 16:45:26 +00:00
Benjamin Peterson d63137159b Merged revisions 65209-65216,65225-65226,65233,65239,65246-65247,65255-65256 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r65209 | raymond.hettinger | 2008-07-23 19:08:18 -0500 (Wed, 23 Jul 2008) | 1 line

  Finish-up the partial conversion from int to Py_ssize_t for deque indices and length.
........
  r65210 | raymond.hettinger | 2008-07-23 19:53:49 -0500 (Wed, 23 Jul 2008) | 1 line

  Parse to the correct datatype.
........
  r65211 | benjamin.peterson | 2008-07-23 21:27:46 -0500 (Wed, 23 Jul 2008) | 1 line

  fix spacing
........
  r65212 | benjamin.peterson | 2008-07-23 21:31:28 -0500 (Wed, 23 Jul 2008) | 1 line

  fix markup
........
  r65213 | benjamin.peterson | 2008-07-23 21:45:37 -0500 (Wed, 23 Jul 2008) | 1 line

  add some documentation for 2to3
........
  r65214 | raymond.hettinger | 2008-07-24 00:38:48 -0500 (Thu, 24 Jul 2008) | 1 line

  Finish conversion from int to Py_ssize_t.
........
  r65215 | raymond.hettinger | 2008-07-24 02:04:55 -0500 (Thu, 24 Jul 2008) | 1 line

  Convert from long to Py_ssize_t.
........
  r65216 | georg.brandl | 2008-07-24 02:09:21 -0500 (Thu, 24 Jul 2008) | 2 lines

  Fix indentation.
........
  r65225 | benjamin.peterson | 2008-07-25 11:55:37 -0500 (Fri, 25 Jul 2008) | 1 line

  teach .bzrignore about doc tools
........
  r65226 | benjamin.peterson | 2008-07-25 12:02:11 -0500 (Fri, 25 Jul 2008) | 1 line

  document default value for fillvalue
........
  r65233 | raymond.hettinger | 2008-07-25 13:43:33 -0500 (Fri, 25 Jul 2008) | 1 line

  Issue 1592:  Better error reporting for operations on closed shelves.
........
  r65239 | benjamin.peterson | 2008-07-25 16:59:53 -0500 (Fri, 25 Jul 2008) | 1 line

  fix indentation
........
  r65246 | andrew.kuchling | 2008-07-26 08:08:19 -0500 (Sat, 26 Jul 2008) | 1 line

  This sentence continues to bug me; rewrite it for the second time
........
  r65247 | andrew.kuchling | 2008-07-26 08:09:06 -0500 (Sat, 26 Jul 2008) | 1 line

  Remove extra words
........
  r65255 | skip.montanaro | 2008-07-26 19:49:02 -0500 (Sat, 26 Jul 2008) | 3 lines

  Close issue 3437 - missing state change when Allow lines are processed.
  Adds test cases which use Allow: as well.
........
  r65256 | skip.montanaro | 2008-07-26 19:50:41 -0500 (Sat, 26 Jul 2008) | 2 lines

  note robotparser bug fix.
........
2008-07-31 16:23:04 +00:00
Georg Brandl 0312494665 Remove last traces of cStringIO. 2008-06-10 15:50:56 +00:00