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
3f4f3ba1a8
#18562 : various revisions to the regex howto for 3.x
...
* describe how \w is different when used in bytes and Unicode patterns.
* describe re.ASCII flag to change that behaviour.
* remove personal references ('I generally prefer...')
* add some more links to the re module in the library reference
* various small edits and re-wording.
2013-08-18 18:57:22 -04: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
43694a50ab
Issue #18668 : Further clarify m_size setting for non-negative values
2013-08-10 05:57:27 -07: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
cdd0279b0b
Fix a typo in PyUnicode_CopyCharacters() documentation.
2013-08-08 16:47:43 +03:00
79016e1d55
#18267 : make whitespace consistent and fix an operator.
2013-08-08 15:45:56 +03:00
0d2d2b8393
Issue #18668 : Properly document setting m_size in PyModuleDef
2013-08-07 05:52:20 -07: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
1c4e443ea2
#16273 : Fix tutorial discussion of seek/tell (opaque text-mode values).
...
Patch by Sijin Joseph.
2013-07-30 15:51:57 -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
3ab7b0aabb
Simplify example of PyErr_Fetch() use
2013-07-30 20:09:03 +02: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
ae6d05bcb9
doc of PYTHONFAULTHANDLER env var: add missing "versionadded" tag
2013-07-28 02:56:50 +02:00
9eda66da78
Issue #18573 : Complete copy-paste from assertRaises entry to assertWarns entry.
2013-07-27 16:15:29 -04:00
b76b1b1ec8
#15130 : remove repeat of abstract paragraph from socket howto body.
...
Patch by Tshepang Lekhonkhobe.
2013-07-25 13:24:15 -04:00
61b0c672b5
#16937 : document that stdin is always buffered, even when -u is used. Patch by Elena Oat.
2013-07-25 05:04:02 +02:00
a92fbe6dce
Issue #18541 : simplified LoggerAdapter example.
2013-07-24 17:52:01 +01: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
244d6252f2
Issue #18085 : Add missed const modifier for some entries in refcounts.dat.
2013-07-11 21:57:34 +03: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
93dd6934ff
#18403 : fix an off-by-one typo noticed by Xue Fuqiao.
2013-07-08 17:52:54 +02: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
51cee7d24a
Issue #18164 : Clarify the embedding docs regarding link options.
2013-06-24 14:22:09 -07: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
2151fc6416
#4153 : update Unicode howto for Python 3.3
...
* state that python3 source encoding is UTF-8, and give examples
* mention surrogateescape in the 'tips and tricks' section, and
backslashreplace in the "Python's Unicode Support" section.
* Describe Unicode support provided by the re module.
* link to Nick Coghlan's and Ned Batchelder's notes/presentations.
* default filesystem encoding is now UTF-8, not ascii.
* Describe StreamRecoder class.
* update acks section
* remove usage of "I think", "I'm not going to", etc.
* various edits
* remove revision history and original outline
2013-06-20 09:29:09 -04:00
fdf9503038
Tweak programming faq examples so that it (mostly) passes doctest.
...
The exception is the import related questions at the end, which
need to be rewritten anyway.
2013-06-19 16:58:26 -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
dce05500a1
Issue #18085 : Fix PyObject_CallMethodObjArgs()'s entry in refcounts.dat.
2013-05-28 22:46:15 +03: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
fef952a607
Issue #18079 : Fix a typo in the tutorial.
2013-05-28 12:49:34 +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
ecf0851809
Fix typo in embedding doc and update examples to 3.3.
2013-05-26 18:53:39 -07:00
4b4e38e7d4
Mention __cached__ in the import ref.
2013-05-25 11:32:50 -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
c1939b8f75
Issue #18031 : %-formatting isn't dead yet and might pull through.
2013-05-23 00:14:47 -07:00
9e62d35e65
Issue #17844 : Add links to encoders and decoders for bytes-to-bytes codecs.
2013-05-22 15:33:09 +03:00
95ae99205e
#17973 : fix technical inaccuracy in faq entry (it now passes doctest).
2013-05-21 11:44:41 -04:00
ea3cfc5f34
Issue #18026 : fix ctypes doc typo
2013-05-20 14:29:44 -07:00
bcf06d364d
#17973 : Add FAQ entry for ([],)[0] += [1] both extending and raising.
...
This has come up often enough now on the tracker that it deserves a FAQ entry.
2013-05-20 10:32:46 -04:00
86aecc360f
#14097 : improve the "introduction" page of the tutorial.
2013-05-20 08:12:32 +03: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
ddcb30440d
#17700 : update the curses HOWTO for 3.x
2013-05-09 20:05:20 -04:00
955382ca54
#17938 : remove duplicate paragraphs.
2013-05-09 15:33:53 +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
25cd09115d
#14187 : Add glossary entry for 'function annotations'.
...
Patch by Chris Rebert.
2013-05-06 12:58:16 -04: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
5de183a07c
Elaborate on bytes-like objects.
2013-05-04 20:18:34 +02: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
Brett Cannon
Serhiy Storchaka
Andrew Kuchling
Vinay Sajip
Antoine Pitrou
David Wolever
Ned Deily
Felix Crux
Eli Bendersky
Ezio Melotti
R David Murray
Terry Jan Reedy
Nick Coghlan
Victor Stinner
Barry Warsaw
Ronald Oussoren
Richard Oudkerk
Raymond Hettinger
Jason R. Coombs
Senthil Kumaran
Georg Brandl
Charles-Francois Natali