Senthil Kumaran
b9183950d8
Clarify mmap.close method behavior. Addresses issue #18815
...
Patch contributed by Anoop Thomas Mathew.
2013-09-09 22:39:28 -07:00
Senthil Kumaran
b505a6ac91
Document Fraction's numerator and denominator properties.
...
Addresses issue #18800
2013-09-09 19:57:37 -07:00
Raymond Hettinger
fb92f393b0
Issue 18752: Make chain.from_iterable() more visible in the documentation.
2013-09-09 02:01:35 -05:00
Raymond Hettinger
1e21ebcc2a
Issue 18301: The classmethod decorator didn't fit well with the rough-equivalent example code.
2013-09-09 01:54:27 -05:00
Nick Coghlan
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
Senthil Kumaran
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
Senthil Kumaran
1b90227c0d
Removing the mention of os.isatty mention as Unix only
...
Correct the wrong documentation.
2013-09-07 11:28:58 -07:00
Ezio Melotti
e64a91a890
#18895 : split a sentence in unittest docs.
2013-09-07 15:23:36 +03:00
Ezio Melotti
e2202365ed
#18894 : remove mention of deprecated fail* methods.
2013-09-07 15:19:30 +03:00
Vinay Sajip
a704582002
Issue #18939 : Updated venv documentation with some clarifications.
2013-09-06 09:50:43 +01:00
Vinay Sajip
31b862d40b
Issue #18933 : Added links to source code.
2013-09-05 23:01:07 +01:00
Serhiy Storchaka
15e6590774
Issue #18760 : Improved cross-references in the xml package.
2013-08-29 10:28:44 +03:00
Serhiy Storchaka
9594942716
Issue #18783 : Removed existing mentions of Python long type in docstrings,
...
error messages and comments.
2013-08-27 19:40:23 +03:00
Eli Bendersky
ca4d97ea8a
Clarify pyexpat documentation in StartElementHandler
2013-08-25 19:05:55 -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
Serhiy Storchaka
9e0ae53980
Issue #18757 : Improved cross-references in the concurrent package.
2013-08-24 00:23:38 +03: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
Serhiy Storchaka
e0f0cf4067
Issue #18761 : Improved cross-references in email documentation.
2013-08-19 09:59:18 +03:00
Andrew Kuchling
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
Vinay Sajip
67f39777fa
Issue #18759 : Improved cross-references in logging documentation.
2013-08-17 00:39:42 +01:00
Serhiy Storchaka
e79be877df
Issue #18743 : Fix references to non-existant "StringIO" module.
2013-08-17 00:09:55 +03:00
Antoine Pitrou
ba69008bd0
Issue #16190 : fix random module recommendation to use ssl.RAND_bytes().
2013-08-16 19:19:40 +02:00
David Wolever
e76c0393a8
Remove errant fourth '.' from ellipsis in datetime documentation.
2013-08-14 14:41:48 -04:00
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
Eli Bendersky
43694a50ab
Issue #18668 : Further clarify m_size setting for non-negative values
2013-08-10 05:57:27 -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
Serhiy Storchaka
cdd0279b0b
Fix a typo in PyUnicode_CopyCharacters() documentation.
2013-08-08 16:47:43 +03:00
Ezio Melotti
79016e1d55
#18267 : make whitespace consistent and fix an operator.
2013-08-08 15:45:56 +03:00
Eli Bendersky
0d2d2b8393
Issue #18668 : Properly document setting m_size in PyModuleDef
2013-08-07 05:52:20 -07: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
1c4e443ea2
#16273 : Fix tutorial discussion of seek/tell (opaque text-mode values).
...
Patch by Sijin Joseph.
2013-07-30 15:51:57 -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
Antoine Pitrou
3ab7b0aabb
Simplify example of PyErr_Fetch() use
2013-07-30 20:09:03 +02: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
Victor Stinner
ae6d05bcb9
doc of PYTHONFAULTHANDLER env var: add missing "versionadded" tag
2013-07-28 02:56:50 +02: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
b76b1b1ec8
#15130 : remove repeat of abstract paragraph from socket howto body.
...
Patch by Tshepang Lekhonkhobe.
2013-07-25 13:24:15 -04:00
Ezio Melotti
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
Vinay Sajip
a92fbe6dce
Issue #18541 : simplified LoggerAdapter example.
2013-07-24 17:52:01 +01: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
