b9183950d8
Clarify mmap.close method behavior. Addresses issue #18815
...
Patch contributed by Anoop Thomas Mathew.
2013-09-09 22:39:28 -07:00
b505a6ac91
Document Fraction's numerator and denominator properties.
...
Addresses issue #18800
2013-09-09 19:57:37 -07:00
fb92f393b0
Issue 18752: Make chain.from_iterable() more visible in the documentation.
2013-09-09 02:01:35 -05:00
1e21ebcc2a
Issue 18301: The classmethod decorator didn't fit well with the rough-equivalent example code.
2013-09-09 01:54:27 -05:00
0494c2ae7f
Close #18952 : correctly download test support data
...
When test.support was converted to a package, it started silently
skipping the tests which needed to download support data to run.
This change refactors the affected code, and also tidies up
test.support.findfile to remove the unused *here* parameter, document
the *subdir* parameter and rename the *filename* parameter to avoid
shadowing the file builtin and be consistent with the documentation.
The unexpected skips were noticed and reported by Zachary Ware
2013-09-08 11:40:34 +10:00
21101f7038
Correct Profile class usage example. Addresses issue #18033 .
...
Patch contributed by Olivier Hervieu and Dmi Baranov.
2013-09-07 17:51:58 -07:00
1b90227c0d
Removing the mention of os.isatty mention as Unix only
...
Correct the wrong documentation.
2013-09-07 11:28:58 -07:00
e64a91a890
#18895 : split a sentence in unittest docs.
2013-09-07 15:23:36 +03:00
e2202365ed
#18894 : remove mention of deprecated fail* methods.
2013-09-07 15:19:30 +03:00
a704582002
Issue #18939 : Updated venv documentation with some clarifications.
2013-09-06 09:50:43 +01:00
31b862d40b
Issue #18933 : Added links to source code.
2013-09-05 23:01:07 +01:00
15e6590774
Issue #18760 : Improved cross-references in the xml package.
2013-08-29 10:28:44 +03:00
9594942716
Issue #18783 : Removed existing mentions of Python long type in docstrings,
...
error messages and comments.
2013-08-27 19:40:23 +03:00
ca4d97ea8a
Clarify pyexpat documentation in StartElementHandler
2013-08-25 19:05:55 -07:00
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
9e0ae53980
Issue #18757 : Improved cross-references in the concurrent package.
2013-08-24 00:23:38 +03:00
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
e0f0cf4067
Issue #18761 : Improved cross-references in email documentation.
2013-08-19 09:59:18 +03:00
67f39777fa
Issue #18759 : Improved cross-references in logging documentation.
2013-08-17 00:39:42 +01:00
e79be877df
Issue #18743 : Fix references to non-existant "StringIO" module.
2013-08-17 00:09:55 +03:00
ba69008bd0
Issue #16190 : fix random module recommendation to use ssl.RAND_bytes().
2013-08-16 19:19:40 +02:00
e76c0393a8
Remove errant fourth '.' from ellipsis in datetime documentation.
2013-08-14 14:41:48 -04:00
eedb58d8d8
Issue 18724: Fix typo noticed by Susan Tan.
2013-08-13 01:12:41 -07:00
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
569a5faaea
Issue #17701 : Improving strftime documentation.
2013-08-12 16:56:02 -04:00
ba5517d4c0
Issue #12645 : Clarify and reformat the documentation of import_fresh_module
2013-08-11 15:38:08 -07:00
d51914c6c1
#18663 : document that assertAlmostEqual also works when the values are equal and add tests.
2013-08-11 13:04:50 +03:00
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
79016e1d55
#18267 : make whitespace consistent and fix an operator.
2013-08-08 15:45:56 +03:00
ca97fd3053
Issue #17902 : Clarify doc of ElementTree.iterparse
2013-08-03 18:52:32 -07:00
39668f57f4
Issue #18589 : fix hyperlinking of type slots (tp_*)
2013-08-01 21:12:45 +02:00
778cba7f29
Issue #18573 : More copy-paste fixes to assertWarns entry.
2013-07-30 22:31:06 -04:00
96433f8e34
#18601 : fix error made when difflib example was converted to use 'with'.
2013-07-30 15:37:11 -04:00
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
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
5517596c04
Close #15415 : Factor out temp dir helpers to test.support
...
Patch by Chris Jerdonek
2013-07-28 22:11:50 +10:00
9eda66da78
Issue #18573 : Complete copy-paste from assertRaises entry to assertWarns entry.
2013-07-27 16:15:29 -04:00
676d7aa905
Issue #18471 : Fix typo in heapq documentation (reported by François Pinard).
2013-07-15 19:08:13 -07:00
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
0995c47891
Issue #18452 : fix several "occurrence" typos (reported by Févry Thibault).
2013-07-14 12:43:16 -07:00
ce10fab9f6
#18389 : Clarify that relpath does not access the file system.
...
Initial patch by Madison May.
2013-07-12 17:43:11 -04:00
577d4ff6e0
Issue #18433 : Clarified venv documentation.
2013-07-12 21:52:51 +01:00
ad6bb031d7
Issue #18434 : Updated example script to tidy up resources.
2013-07-12 21:44:35 +01:00
3c557f298a
Issue #18434 : Updated example script in venv docs to use setuptools rather than Distribute.
2013-07-12 20:54:25 +01:00
5a33f81348
#17987 : properly document support.captured_xxx.
...
Patch by Dmi Baranov.
2013-07-11 12:28:40 -04:00
cca40ffa97
Issue #18336 . Fix a link to StreamReader's read() method.
2013-07-11 18:26:13 +03:00
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
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
d7d3f376dd
Issue #14206 : Clarify docs for Queue.join_cancel_thread().
2013-07-02 12:59:55 +01:00
b3c4b98c23
Issue #17273 : Clarify that pool methods can only be used by parent process.
2013-07-02 12:32:00 +01:00
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
c4565a9524
Issue #18237 : Fix assertRaisesRegexp error caought by Jeff Tratner.
2013-06-29 13:15:43 -04:00
c7f7579855
#18311 : fix typo.
2013-06-26 15:11:12 -04:00
2b310dd8b9
Fix typo.
2013-06-24 20:38:46 +01:00
7b69da72b8
Clarify note and fix typo.
2013-06-24 18:12:57 +01:00
64c25b4282
Issue #15818 : Typo in docs.
2013-06-24 15:42:00 +01:00
95fe1a793f
Issue #18277 : Document quirks of multiprocessing queue.
2013-06-24 14:48:07 +01:00
021362dbd4
#18179 : reflow paragraphs.
2013-06-23 16:05:44 -04:00
36beb66be9
#18179 : document the local_hostname parameter.
...
Original patch by Berker Peksag.
2013-06-23 15:47:50 -04:00
29b2f174da
Issue #18278 : properly document how the loaders are called for FileFinder
2013-06-21 18:31:55 -04:00
edb4260ffd
Closes #18218 : use correct variable name for starting point
2013-06-21 08:00:58 -04:00
c3db3739aa
Closes #18267 : use floor division in code example
2013-06-20 21:33:05 -04:00
1d7d580d0e
Closes #18272 : use 'builtins' for 3.3 instead of __builtin__
2013-06-20 21:17:41 -04:00
a269d821a1
merge
2013-06-16 19:07:16 -04:00
1d75382e81
Fix a misnaming of a method and an argument
2013-06-16 19:06:55 -04:00
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
3886120428
Issue #18187 : Fix broken link in venv documentation. Patch by Berker Peksag.
2013-06-11 14:38:39 -07:00
c1f5839412
#18126 : update NumPy links in the documentation. Patch by Yury V. Zaytsev.
2013-06-09 01:04:21 +03:00
d71001749d
Clarify which dictionaries are updateable
...
by using the wording from the Py2.7 docs.
2013-06-02 10:03:05 -07:00
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
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
533f1ed334
Add a missing parenthesis.
2013-05-25 11:28:20 -04:00
2cefb3cf96
Various tweaks to importlib docs.
2013-05-25 11:26:11 -04:00
c3511c1dd8
Issue #17953 : document that sys.modules shouldn't be replaced (thanks
...
to interp->modules) and that deleting essential items from the dict
can cause Python to blow up.
Thanks to Terry Reedy for coming up with initial wording and Yogesh
Chaudhari for coming up with a patch using that wording in parallel to
my own patch.
2013-05-24 08:05:07 -04:00
05ec6aca3a
Fix #18007 : Document CookieJar.add_cookie_header request parameter changes in 3.3
2013-05-23 05:27:38 -07:00
650e322fc6
Issue 17844: Clarify meaning of different codec tables
2013-05-23 20:24:02 +10:00
9e62d35e65
Issue #17844 : Add links to encoders and decoders for bytes-to-bytes codecs.
2013-05-22 15:33:09 +03:00
ea3cfc5f34
Issue #18026 : fix ctypes doc typo
2013-05-20 14:29:44 -07:00
d486707d2e
- Issue #17977 : The documentation for the cadefault argument's default value
...
in urllib.request.urlopen() is fixed to match the code.
2013-05-14 11:35:16 -04:00
521ed52131
Closes issue #17732 : ignore install-directory specific options in
...
distutils.cfg when a venv is active.
2013-05-12 12:36:07 +02:00
d8f870d0fa
I was confused before. It's correct to not call .close() inside the with
...
statement, but add a comment that clarifies the purpose of the code.
2013-05-10 11:35:38 -04:00
173d4109b5
#17841 : remove missing codecs aliases from the documentation. Patch by Thomas Fenzl.
2013-05-10 05:21:35 +03:00
babc8227cc
#16523 : improve attrgetter/itemgetter/methodcaller documentation.
2013-05-08 10:53:11 +03:00
c58a3ea72c
#17714 : document that the base64 codec adds a trailing newline.
2013-05-07 11:14:27 +03:00
9c939bceeb
#17871 : fix unittest.TextTestRunner signature in the docs. Patch by Yogesh Chaudhari.
2013-05-07 09:46:30 +03:00
12f588adeb
Issue 17920: Fix-up terminology in the set documentation
2013-05-06 18:22:43 -07:00
44571daf0e
Issue 17862: Improve the signature of itertools grouper() recipe.
...
Putting *n* after the *iterable* matches the signature of other itertools
and recipes. Also, it reads better.
Suggested by Ezio Melotti.
2013-05-05 19:53:41 -07:00
c228e96726
#16518 : use "bytes-like object" throughout the docs.
2013-05-04 18:06:34 +03:00
a771a1b48e
Issue #17529 : Fix os.sendfile() documentation regarding the type of file
...
descriptor supported.
2013-05-01 15:12:20 +02:00
ab6ab15e7d
#17881 : clarify documentation of plistlib.
2013-04-30 16:34:04 +03:00
9330a94467
Reflow paragraphs.
...
I know one of them looks worse, but now it is <80 chars and
matches the 2.7 text.
2013-04-28 11:24:35 -04:00
5aea37ad1d
#7152 : Clarify that ProxyHandler is added only if proxy settings are detected.
...
Behavior confirmation and initial patch by Jessica McKellar.
2013-04-28 11:07:16 -04:00
4067aa272e
Issue #17357 : Use more stern wording for
...
importlib.invalidate_caches().
2013-04-27 23:20:32 -04:00
bebe91a0ef
Issue #17670 : Provide an example of expandtabs() usage.
2013-04-21 13:05:21 -07:00
bdf940d3bd
#17409 : Document RLIM_INFINITY and use it to clarify the setrlimit docs.
2013-04-20 13:37:34 -04:00
0aa685a33c
Minor typo in example.
2013-04-19 11:32:25 -04:00
bca1a2629a
#17135 : Add note in imp to use importlib for new programs.
2013-04-18 09:51:17 -04:00
a68c1ab571
#17771 : fix typo. Patch by Andriy Mysyk.
2013-04-17 07:34:13 +03:00
c048d98501
#17740 : fix links to the socket function. Initial patch by Zachary Ware.
2013-04-17 04:10:26 +03:00
d34941ad4e
Issue #17739 : fix the description of SSLSocket.getpeercert(binary_form=True) for server sockets.
...
Thanks to David D Lowe for reporting.
2013-04-16 20:27:17 +02:00
ed3cd7e445
#13510 : clarify that f.readlines() is note necessary to iterate over a file. Patch by Dan Riti.
2013-04-15 19:08:31 +03:00
45fe62dc9c
Issue #17728 : Specify default precision for float.format for presentation types e, f, and g.
2013-04-15 09:51:54 -04:00
1aca953a40
Fix example ignoring ".svn" directories in compileall.
2013-04-14 12:02:43 +02:00
1e1134a314
The Integral class does not contain implementations for the bit-shifting operations. (See #3056.)
2013-04-14 11:58:54 +02:00
5f4b4ac73e
Update code examples using collections.abc classes.
2013-04-14 10:50:05 +02:00
0bfd6acf03
Reflow paragraph.
2013-04-13 14:40:51 -04:00
14ee3cf244
#2118 : clarify smtplib exception documentation.
2013-04-13 14:40:33 -04:00
a3b255f275
#17653 : fix typo in socketserver docs. Patch by Tshepang Lekhonkhobe.
2013-04-12 19:19:21 +03:00
075d87cf05
#6696 : add documentation for the Profile objects, and improve profile/cProfile docs. Patch by Tom Pinckney.
2013-04-12 15:42:06 +03:00
c09959ae0f
#17635 : fix wrong function name in multiprocessing docs.
2013-04-10 17:59:20 +03:00
595365de32
Merge heads
2013-04-07 14:47:05 +03:00
5b6e1cad37
Update argparse docs to follow order of ArgumentParser() arguments.
2013-04-07 14:43:17 +03:00
17328e4fae
Clean-up lru_cache examples. The print() not is needed. Set maxsize to a power of two.
2013-04-06 20:27:33 -07:00
cca5548159
merge with 3.3.1 release clone
2013-04-06 16:42:43 +02:00
9a411ce9ea
Add link to glossary for hashable term in docs for set type
2013-04-05 16:21:50 +03:00
09f0ddec21
#8913 : add examples and docs for date/time/datetime.__format__. Patch by Heikki Partanen.
2013-04-04 09:16:15 +03:00
41459a9b29
Issue #15940 : Replace tab.
2013-04-03 12:45:24 -04:00
b5e2e7e93a
Issue #15940 : Specify effect of locale on time functions.
2013-04-03 12:34:57 -04:00
19aeb439c6
Issue #17435 : Don't use mutable default values in Timer.
...
Patch by Denver Coneybeare with some test modifications by me.
2013-03-30 17:19:38 -04:00
b40a2203ad
#17539 : fix MagicMock example. Patch by Berker Peksag.
2013-03-30 05:55:52 +02:00
6d2bc6e80b
#17438 : add links to the conversion tables in dump(s)/load(s).
2013-03-29 03:59:29 +02:00
44ea77bd81
Closes #4159 : add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.
2013-03-28 13:28:44 +01:00
6ba6b13e32
Fix XML vulnerability link targets.
2013-03-28 09:11:44 +01:00
6f18a8648b
Fix XML vulnerability link references.
2013-03-28 09:02:18 +01:00
fd4365a4d8
Update suspicious ignore file.
2013-03-28 04:31:53 +02:00
184e59357e
#17329 : merge with 3.2.
2013-03-27 20:12:55 +02:00
265281ac02
#17329 : document unittest.SkipTest. Initial patch by Zachary Ware.
2013-03-27 20:11:55 +02:00
768f6a5360
Issue 17538: Document XML vulnerabilties
2013-03-26 17:47:23 +01:00
7380a67267
Issue 17538: Document XML vulnerabilties
2013-03-26 17:35:55 +01:00
a809e4a540
merge with upstream 3.3 branch
2013-03-25 07:01:37 +01:00
a1b9ed32ee
Fixes issue #17488 : Change the subprocess.Popen bufsize parameter default value
...
from unbuffered (0) to buffering (-1) to match the behavior existing code
expects and match the behavior of the subprocess module in Python 2 to avoid
introducing hard to track down bugs.
2013-03-23 11:54:22 -07:00
a1ed539268
Fixes issue #17488 : Change the subprocess.Popen bufsize parameter default value
...
from unbuffered (0) to buffering (-1) to match the behavior existing code
expects and match the behavior of the subprocess module in Python 2 to avoid
introducing hard to track down bugs.
2013-03-23 11:44:25 -07:00
3ddba16aa6
Update collections ABC table to match the __abstractmethods__ attribute for each container.
2013-03-23 09:07:36 -07:00
378170d5d9
Issue 17447: Clarify that str.isidentifier doesn't check for reserved keywords.
2013-03-23 08:21:12 -07:00
0a1bc11c66
Fix suspicious markup in the docs.
2013-03-23 15:59:46 +01:00
74b24047e3
merge
2013-03-20 18:32:22 -07:00
1f8a40b81d
remove the long obsolete mention of universal newlines mode only being
...
available when configured at compile time.
2013-03-20 18:32:03 -07:00
ba7dd670cb
Merge usage of argument/parameter and markup fixes from 3.2.
2013-03-20 13:54:18 +02:00
93115e0914
Fix usage of argument/parameter and markup.
2013-03-20 13:53:32 +02:00
f16455aa4a
clarifiy the documentation for issue17285. see also commit
...
ee30400efceb which updated the docstring.
2013-03-19 23:36:31 -07:00
cd3bb8b73c
#17474 - Mark the deprecated Request methods as deprecated-removed. Review by Ezio Melotti
2013-03-19 18:01:43 -07:00
432a48a0c8
Merge: #1525919 : Document MIMEText+set_payload encoding behavior.
2013-03-19 18:21:22 -04:00
14b0124a29
#1525919 : Document MIMEText+set_payload encoding behavior.
2013-03-19 18:18:55 -04:00
2f306c03d3
#17460 - merge from 3.2
2013-03-19 00:58:46 -07:00
0492ec07e0
#17460 - Adding relevant warning messages regarding strict removal in docs
2013-03-19 00:51:08 -07:00
6227c6952e
#10050 - Document DeprecationWarnings for URLopener and FancyURLopener (msg172874 )
2013-03-18 17:09:50 -07:00
f575230981
Documentation corrections for unittest.mock
2013-03-18 15:04:03 -07:00
1f2a49cfc6
Merge #16057 : Clarify why the base method default is called in custom encoders.
...
Original patch by Kushal Das.
2013-03-17 21:53:23 -04:00
dd246171e4
#16057 : Clarify why the base method default is called in custom encoders.
...
Original patch by Kushal Das.
2013-03-17 21:52:35 -04:00
b271727bad
Merge with 3.2
2013-03-17 15:28:52 -04:00
Senthil Kumaran
Raymond Hettinger
Nick Coghlan
Ezio Melotti
Vinay Sajip
Serhiy Storchaka
Eli Bendersky
Brett Cannon
Antoine Pitrou
David Wolever
Ned Deily
Felix Crux
R David Murray
Terry Jan Reedy
Barry Warsaw
Ronald Oussoren
Richard Oudkerk
Andrew Kuchling
Jason R. Coombs
Georg Brandl
Charles-Francois Natali
Eric V. Smith
Andrew Svetlov
Christian Heimes
Gregory P. Smith
Michael Foord