Eli Bendersky
c020e7f8cb
Merge doc fix from 3.3
2013-08-25 15:30:39 -07:00
Eli Bendersky
bf8ab77f94
Update XMLParser.close documentation and fix formatting.
...
Using ``method`` markup because the method is on a callback object, not an
explicitly documented method. :meth: markup creates links within the current
class which is incorrect.
In addition, indent the paragraph correctly.
2013-08-25 15:27:36 -07:00
Ezio Melotti
74eba65fb6
Fix markup in elementtree docs.
2013-08-26 01:05:57 +03:00
Eli Bendersky
bfd78370a5
Clarify the documentation of XMLParser.close
...
The return value of close() is not always a toplevel element. It depends on
what the underlying target returns. By default, TreeBuilder returns the
toplevel document element.
2013-08-24 15:11:44 -07:00
Serhiy Storchaka
96d5c54130
Issue #18757 : Improved cross-references in the concurrent package.
2013-08-24 00:27:59 +03:00
Serhiy Storchaka
9e0ae53980
Issue #18757 : Improved cross-references in the concurrent package.
2013-08-24 00:23:38 +03:00
Ezio Melotti
6e6c6ac3d7
#18796 : improve documentation of the file argument of dis.show_code. Initial patch by Vajrasky Kok.
2013-08-23 22:41:39 +03:00
Brett Cannon
f9f0458961
merge emphasized discouragement of overriding __import__
2013-08-23 11:00:04 -04:00
Brett Cannon
f5ebd26403
Emphasize that people should not override __import__.
...
With importlib getting used more and more, changing __import__ will
not work as well as people used to hope as it will potentially bypass
importers, etc. It also will not work with importlib.import_module()
as it uses "importlib.__import__" (i.e. importlib's implementation of
import) directly and not builtins.__import__.
2013-08-23 10:58:49 -04:00
Victor Stinner
13423c3726
Close #18794 : Add a fileno() method and a closed attribute to select.devpoll
...
objects.
Add also tests on fileno() method and closed attribute of select.epoll and select.kqueue.
2013-08-22 00:19:50 +02: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
Vinay Sajip
07b16615bc
Issue #18759 : Merged updates from 3.3.
2013-08-17 00:40:38 +01:00
Vinay Sajip
67f39777fa
Issue #18759 : Improved cross-references in logging documentation.
2013-08-17 00:39:42 +01:00
Serhiy Storchaka
bbbf191707
Issue #18743 : Fix references to non-existant "StringIO" module.
2013-08-17 00:11:54 +03:00
Serhiy Storchaka
e79be877df
Issue #18743 : Fix references to non-existant "StringIO" module.
2013-08-17 00:09:55 +03:00
Antoine Pitrou
c593056744
Fix the default placeholder in textwrap.shorten() to be " [...]".
...
For some reason I forgot to do it before committing the patch in issue #18585 .
2013-08-16 22:31:12 +02:00
Antoine Pitrou
53e5b5e581
Issue #16190 : fix random module recommendation to use ssl.RAND_bytes().
2013-08-16 19:20:04 +02:00
Antoine Pitrou
ba69008bd0
Issue #16190 : fix random module recommendation to use ssl.RAND_bytes().
2013-08-16 19:19:40 +02:00
Christian Heimes
d88f735f17
Issue #18673 : Add versionchanged to docs
2013-08-16 14:37:50 +02:00
Christian Heimes
177b3f9982
Issue #18673 : Add O_TMPFILE to os module. O_TMPFILE requires Linux kernel
...
3.11 or newer. It's only defined on system with 3.11 uapi headers, too.
2013-08-16 14:35:09 +02:00
David Wolever
5d07e70568
Remove errant fourth '.' from ellipsis in datetime documentation.
2013-08-14 14:41:48 -04:00
David Wolever
e76c0393a8
Remove errant fourth '.' from ellipsis in datetime documentation.
2013-08-14 14:41:48 -04:00
Richard Oudkerk
84ed9a68bd
Issue #8713 : Support alternative start methods in multiprocessing on Unix.
...
See http://hg.python.org/sandbox/sbt#spawn
2013-08-14 15:35:41 +01:00
Ned Deily
7cf5e61b83
Issue 18724: Fix typo noticed by Susan Tan.
2013-08-13 01:15:14 -07:00
Ned Deily
eedb58d8d8
Issue 18724: Fix typo noticed by Susan Tan.
2013-08-13 01:12:41 -07:00
Felix Crux
654f003a13
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
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
Felix Crux
b435799520
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
Felix Crux
60fb9719a1
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
bbf4a46304
Merge issue #17701 : Improving strftime documentation.
2013-08-12 17:15:36 -04:00
David Wolever
569a5faaea
Issue #17701 : Improving strftime documentation.
2013-08-12 16:56:02 -04:00
Antoine Pitrou
389dec8bcf
Issue #18585 : Add :func:`textwrap.shorten` to collapse and truncate a piece of text to a given length.
2013-08-12 22:39:09 +02:00
Eli Bendersky
01ea326a8e
Close #12645 : Clarify and reformat the documentation of import_fresh_module
2013-08-11 15:43:30 -07: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
b2855ccd09
#18663 : merge with 3.3.
2013-08-11 13:05:37 +03: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
Ethan Furman
a4998a7041
Close #18264 : int- and float-derived enums now converted to int or float.
2013-08-10 13:01:45 -07: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
Ezio Melotti
3e4477ced0
#18267 : merge with 3.3.
2013-08-08 15:46:13 +03:00
Ezio Melotti
79016e1d55
#18267 : make whitespace consistent and fix an operator.
2013-08-08 15:45:56 +03:00
Antoine Pitrou
58720d6145
Issue #17934 : Add a clear() method to frame objects, to help clean up expensive details (local variables) and break reference cycles.
2013-08-05 23:26:40 +02:00
Jason R. Coombs
b2aa6f4055
Issue 18532: Added tests and documentation to formally specify the .name attribute on hashlib objects.
2013-08-03 11:39:39 +02:00
Alexander Belopolsky
790d269d39
Fixes #8860 : Round half-microseconds to even in the timedelta constructor.
...
(Original patch by Mark Dickinson.)
2013-08-04 14:51:35 -04:00
Eli Bendersky
c4216ab92b
Issue #17902 : Clarify doc of ElementTree.iterparse and IncrementalParser
...
Based on patch by Aaron Oakley
2013-08-03 18:55:10 -07:00
Eli Bendersky
ca97fd3053
Issue #17902 : Clarify doc of ElementTree.iterparse
2013-08-03 18:52:32 -07:00
Larry Hastings
d36fc4307e
Fix minor documentation markup error.
2013-08-03 02:49:53 -07:00
Antoine Pitrou
a68cbfa556
Issue #18589 : fix hyperlinking of type slots (tp_*)
2013-08-01 21:14:43 +02:00
Antoine Pitrou
39668f57f4
Issue #18589 : fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
R David Murray
536ffe161c
#17616 : Improve context manager tests, fix bugs in close method and mode docs.
...
'mode' docs fix: the file must always be opened in binary in Python3.
Bug in Wave_write.close: when the close method calls the check that the header
exists and it raises an error, the _file attribute never gets set to None, so
the next close tries to close the file again and we get an ignored traceback
in the __del__ method. The fix is to set _file to None in a finally clause.
This represents a behavior change...in theory a program could be checking for
the error on close and then doing a recovery action on the still open file and
closing it again. But this change will only go into 3.4, so I think that
behavior change is acceptable given that it would be pretty weird and unlikely
logic to begin with.
2013-07-31 20:48:26 -04:00
R David Murray
c91d5eea10
#17616 : wave.open now supports the 'with' statement.
...
Feature and tests by ClClaudiu.Popa, I added the doc changes.
2013-07-31 13:46:08 -04:00
Terry Jan Reedy
92e2a220ef
Merge with 3.3
2013-07-30 22:31:30 -04: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
f392c604e7
Merge: #18601 : fix error made when difflib example was converted to use 'with'.
2013-07-30 15:37:43 -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
Ethan Furman
9026262507
fixed examples to work with changed attribute names
2013-07-30 12:24:25 -07:00
R David Murray
20ac14fbad
Merge #18584 : s/testcleanup/testsetup/ until we switch to Sphinx 1.1.
2013-07-30 14:43:10 -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
Antoine Pitrou
796564c27b
Issue #18112 : PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
R David Murray
299a221940
Merge #18584 : make doctest examples in email documentation pass.
2013-07-29 15:56:26 -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
cf67b2a891
Merge #15415 from 3.3
2013-07-28 22:25:25 +10: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
Nick Coghlan
e8c45d6d0e
Close #13266 : Add inspect.unwrap
...
Initial patch by Daniel Urban and Aaron Iles
2013-07-28 20:00:01 +10:00
Terry Jan Reedy
937b50c378
Merge with 3.3
2013-07-27 16:15:51 -04:00
Terry Jan Reedy
9eda66da78
Issue #18573 : Complete copy-paste from assertRaises entry to assertWarns entry.
2013-07-27 16:15:29 -04:00
R David Murray
4d35e75ca0
#17818 : aifc.getparams now returns a namedtuple.
...
Patch by Claudiu Popa.
2013-07-25 16:12:01 -04:00
Ethan Furman
f24bb35a69
closes issue18042 -- a `unique` decorator is added to enum.py
...
The docs also clarify the 'Interesting Example' duplicate-free enum is for
demonstration purposes.
2013-07-18 17:05:39 -07:00
Ned Deily
eaaedcdd89
Closes #18471 : Fix typo in heapq documentation (reported by François Pinard).
2013-07-15 19:09:27 -07: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
Barry Warsaw
4958f714bd
- Issue #18440 : Clarify that `hash()` can truncate the value returned from an
...
object's custom `__hash__()` method.
2013-07-15 15:21:41 -04:00
Nick Coghlan
24c05bc154
Close issue 17482: don't overwrite __wrapped__
2013-07-15 21:13:08 +10:00
Ned Deily
d57b268653
Closes #18452 : fix several "occurrence" typos (reported by Févry Thibault).
2013-07-14 12:45:18 -07: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
d0a03ad139
#18389 : Clarify that relpath does not access the file system.
...
Initial patch by Madison May.
2013-07-12 17:43:53 -04: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
11b38f17ca
Closes #18433 : Merged documentation update from 3.3.
2013-07-12 21:54:12 +01:00
Vinay Sajip
577d4ff6e0
Issue #18433 : Clarified venv documentation.
2013-07-12 21:52:51 +01:00
Vinay Sajip
c1a9d30354
Merged changes.
2013-07-12 21:46:05 +01:00
Vinay Sajip
ad6bb031d7
Issue #18434 : Updated example script to tidy up resources.
2013-07-12 21:44:35 +01:00
Vinay Sajip
62926eed68
Closes #18434 : Merged documentation update from 3.3.
2013-07-12 20:58:14 +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
e173d01231
Merge #17987 : properly document support.captured_xxx.
2013-07-11 12:29:31 -04: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
491856074f
Issue #18336 . Fix a link to StreamReader's read() method.
2013-07-11 18:27:20 +03:00
Serhiy Storchaka
cca40ffa97
Issue #18336 . Fix a link to StreamReader's read() method.
2013-07-11 18:26:13 +03:00
Ronald Oussoren
5f8e78545c
(3.3->default) Cleanup of documentation change from #17860
...
Reformulated the textual change, and applied it to the docstring as well.
2013-07-07 09:28:01 +02: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
c17d0c2218
(3.3->default) 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:25:04 +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
Brett Cannon
679ecb565b
Issue #15767 : back out 8a0ed9f63c6e, finishing the removal of
...
ModuleNotFoundError.
2013-07-04 17:51:50 -04:00
Brett Cannon
82da8886cc
Issue #15767 : Revert 3a50025f1900 for ModuleNotFoundError
2013-07-04 17:48:16 -04:00
Richard Oudkerk
771b961d4e
Issue #14206 : Clarify docs for Queue.join_cancel_thread().
2013-07-02 13:01:31 +01:00
Richard Oudkerk
d7d3f376dd
Issue #14206 : Clarify docs for Queue.join_cancel_thread().
2013-07-02 12:59:55 +01:00
Richard Oudkerk
b0be62453f
Issue #17273 : Clarify that pool methods can only be used by parent process.
2013-07-02 12:41:00 +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
Christian Heimes
04926aeb2f
Issue 18240: The HMAC module is no longer restricted to bytes and accepts
...
any bytes-like object, e.g. memoryview. Original patch by Jonas Borgström.
2013-07-01 13:08:42 +02:00
Terry Jan Reedy
ec4bdac8dd
(merge) 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:52:18 -04:00