Commit graph

4552 commits

Author SHA1 Message Date
Ned Deily
eedb58d8d8 Issue 18724: Fix typo noticed by Susan Tan. 2013-08-13 01:12:41 -07:00
Felix Crux
bc4b8ebc8b Documenting that json.load may raise a ValueError.
Issue #18680: JSONDecoder should document that it raises a ValueError
  for malformed data
2013-08-12 17:39:51 -04:00
David Wolever
569a5faaea Issue #17701: Improving strftime documentation. 2013-08-12 16:56:02 -04:00
Eli Bendersky
ba5517d4c0 Issue #12645: Clarify and reformat the documentation of import_fresh_module 2013-08-11 15:38:08 -07:00
Ezio Melotti
d51914c6c1 #18663: document that assertAlmostEqual also works when the values are equal and add tests. 2013-08-11 13:04:50 +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
Ezio Melotti
79016e1d55 #18267: make whitespace consistent and fix an operator. 2013-08-08 15:45:56 +03:00
Eli Bendersky
ca97fd3053 Issue #17902: Clarify doc of ElementTree.iterparse 2013-08-03 18:52:32 -07:00
Antoine Pitrou
39668f57f4 Issue #18589: fix hyperlinking of type slots (tp_*) 2013-08-01 21:12:45 +02:00
Terry Jan Reedy
778cba7f29 Issue #18573: More copy-paste fixes to assertWarns entry. 2013-07-30 22:31:06 -04:00
R David Murray
96433f8e34 #18601: fix error made when difflib example was converted to use 'with'. 2013-07-30 15:37:11 -04:00
R David Murray
11bfd32881 #18584: s/testcleanup/testsetup/ until we switch to Sphinx 1.1.
testcleanup directive is new as of 1.1, and we are currently running
1.0.7.  But using testsetup works just as well, and avoids the
unknown directive error when building the docs.
2013-07-30 14:42:40 -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
Nick Coghlan
5517596c04 Close #15415: Factor out temp dir helpers to test.support
Patch by Chris Jerdonek
2013-07-28 22:11:50 +10:00
Terry Jan Reedy
9eda66da78 Issue #18573: Complete copy-paste from assertRaises entry to assertWarns entry. 2013-07-27 16:15:29 -04:00
Ned Deily
676d7aa905 Issue #18471: Fix typo in heapq documentation (reported by François Pinard). 2013-07-15 19:08:13 -07:00
Barry Warsaw
224a599c0c - Issue #18440: Clarify that hash() can truncate the value returned from an
object's custom `__hash__()` method.
2013-07-15 14:47:29 -04:00
Ned Deily
0995c47891 Issue #18452: fix several "occurrence" typos (reported by Févry Thibault). 2013-07-14 12:43:16 -07:00
R David Murray
ce10fab9f6 #18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
2013-07-12 17:43:11 -04:00
Vinay Sajip
577d4ff6e0 Issue #18433: Clarified venv documentation. 2013-07-12 21:52:51 +01:00
Vinay Sajip
ad6bb031d7 Issue #18434: Updated example script to tidy up resources. 2013-07-12 21:44:35 +01:00
Vinay Sajip
3c557f298a Issue #18434: Updated example script in venv docs to use setuptools rather than Distribute. 2013-07-12 20:54:25 +01:00
R David Murray
5a33f81348 #17987: properly document support.captured_xxx.
Patch by Dmi Baranov.
2013-07-11 12:28:40 -04:00
Serhiy Storchaka
cca40ffa97 Issue #18336. Fix a link to StreamReader's read() method. 2013-07-11 18:26:13 +03:00
Ronald Oussoren
385521c90e Cleanup of documentation change from #17860
Reformulated the textual change, and applied it to the docstring as well.
2013-07-07 09:26:45 +02:00
Ronald Oussoren
a68650553d Issue #17860: explicitly mention that std* streams are opened in binary mode by default.
The documentation does mention that the streams are opened in text mode
when univeral_newlines is true, but not that that they are opened in
binary mode when that argument is false and that seems to confuse at
least some users.
2013-07-06 10:23:59 +02:00
Richard Oudkerk
d7d3f376dd Issue #14206: Clarify docs for Queue.join_cancel_thread(). 2013-07-02 12:59:55 +01:00
Richard Oudkerk
b3c4b98c23 Issue #17273: Clarify that pool methods can only be used by parent process. 2013-07-02 12:32:00 +01:00
Terry Jan Reedy
8a0b7756e2 Issue #7136: In the Idle File menu, "New Window" is renamed "New File".
Patch by Tal Einat, Roget Serwy, and Todd Rovito.
2013-07-01 00:42:52 -04:00
Terry Jan Reedy
c4565a9524 Issue #18237: Fix assertRaisesRegexp error caought by Jeff Tratner. 2013-06-29 13:15:43 -04:00
R David Murray
c7f7579855 #18311: fix typo. 2013-06-26 15:11:12 -04:00
Richard Oudkerk
2b310dd8b9 Fix typo. 2013-06-24 20:38:46 +01:00
Richard Oudkerk
7b69da72b8 Clarify note and fix typo. 2013-06-24 18:12:57 +01:00
Richard Oudkerk
64c25b4282 Issue #15818: Typo in docs. 2013-06-24 15:42:00 +01:00
Richard Oudkerk
95fe1a793f Issue #18277: Document quirks of multiprocessing queue. 2013-06-24 14:48:07 +01:00
R David Murray
021362dbd4 #18179: reflow paragraphs. 2013-06-23 16:05:44 -04:00
R David Murray
36beb66be9 #18179: document the local_hostname parameter.
Original patch by Berker Peksag.
2013-06-23 15:47:50 -04:00
Brett Cannon
29b2f174da Issue #18278: properly document how the loaders are called for FileFinder 2013-06-21 18:31:55 -04:00
Andrew Kuchling
edb4260ffd Closes #18218: use correct variable name for starting point 2013-06-21 08:00:58 -04:00
Andrew Kuchling
c3db3739aa Closes #18267: use floor division in code example 2013-06-20 21:33:05 -04:00
Andrew Kuchling
1d7d580d0e Closes #18272: use 'builtins' for 3.3 instead of __builtin__ 2013-06-20 21:17:41 -04:00
Brett Cannon
a269d821a1 merge 2013-06-16 19:07:16 -04:00
Brett Cannon
1d75382e81 Fix a misnaming of a method and an argument 2013-06-16 19:06:55 -04:00
Andrew Kuchling
c7b6c50f29 Describe 'surrogateescape' in the documentation.
Also, improve some docstring descriptions of the 'errors' parameter.

Closes #14015.
2013-06-16 12:58:48 -04:00
Ned Deily
3886120428 Issue #18187: Fix broken link in venv documentation. Patch by Berker Peksag. 2013-06-11 14:38:39 -07:00
Ezio Melotti
c1f5839412 #18126: update NumPy links in the documentation. Patch by Yury V. Zaytsev. 2013-06-09 01:04:21 +03:00
Raymond Hettinger
d71001749d Clarify which dictionaries are updateable
by using the wording from the Py2.7 docs.
2013-06-02 10:03:05 -07:00
Serhiy Storchaka
ea2b490f3d Issue #18011: base64.b32decode() now raises a binascii.Error if there are
non-alphabet characters present in the input string to conform a docstring.
Updated the module documentation.
2013-05-28 15:27:29 +03:00
Jason R. Coombs
3a09286790 Issue #13772: Restored directory detection of targets in os.symlink on Windows, which was temporarily removed in Python 3.2.3 due to an incomplete implementation. The implementation now works even if the symlink is created in a location other than the current directory. 2013-05-27 23:21:28 -04:00
Brett Cannon
533f1ed334 Add a missing parenthesis. 2013-05-25 11:28:20 -04:00