72aabb6177
Merge heads
2013-10-13 23:27:23 +03:00
810f1d56ea
Wing IDE is switching to PyQt...
2013-10-13 22:23:27 +02:00
c3a2916919
Closes #19248 : actually check for Python 3.x in tools/sphinx-build.py.
2013-10-13 22:19:49 +02:00
bfdcd436f0
Issue #18758 : Fixed and improved cross-references.
2013-10-13 23:09:14 +03:00
4e985673bf
Issue #19197 : Improved cross-references in the shlex module documentation.
2013-10-13 21:19:00 +03:00
dab8354920
Issue #19207 : Improved cross-references in the os, os.path, and posix modules
...
documentation.
2013-10-13 20:12:43 +03:00
5e1c053f0c
Improve #19204 : Improved cross-references in the urllib package documentation.
2013-10-13 20:06:50 +03:00
b7117af07d
Refer to strftime(3) manpage for platform specific format codes.
...
Suggested by Skip Montanaro on docs@.
2013-10-13 18:28:25 +02:00
04d11a73fa
Issue #19203 : Improved cross-references in the curses howto.
2013-10-13 18:51:59 +03:00
fd1c3d3059
Issue #19198 : Improved cross-references in the cgi module documentation.
2013-10-13 18:28:26 +03:00
6cb2b5b1e1
Issue #17827 : Document codecs.encode and codecs.decode
2013-10-14 00:22:13 +10:00
aeaecfd257
Closes #13740 : SND_NOWAIT seems to be ignored on modern Windows.
2013-10-13 10:49:41 +02:00
5d5b375c84
Fix a small CSS glitch with deprecated blocks and Sphinx 1.2.
2013-10-13 09:56:20 +02:00
1e32011306
Fix display of deprecated blocks with Sphinx 1.2.
2013-10-13 09:31:42 +02:00
64801680d3
Issue #19202 : Add cross-reference and a rough code equivalent
2013-10-12 16:04:17 -07:00
a14034872b
Invert logic of new limited-API annotation and call it "stable ABI".
2013-10-12 22:55:34 +02:00
239990daec
Fix compatibility with upcoming Sphinx 1.2.
2013-10-12 20:50:21 +02:00
5c01d99c12
Introduce support for documenting which C API elements are not part of the stable/limited API.
2013-10-12 19:54:30 +02:00
5db7c54f96
Closes #13915 : update tutorial with respect to .pyc files (__pycache__ / PEP 3147).
...
Initial wording proposed by John Roth.
2013-10-12 19:13:23 +02:00
ae30a813a9
Closes #13833 : document PyStructSequence C-API functions.
2013-10-12 19:03:43 +02:00
c96ef1f0ed
Closes #13026 : fix documentation of MAKE_FUNCTION for 3.x.
2013-10-12 18:41:18 +02:00
57f936ecde
Closes #19179 : make table of XML vulnerabilities clearer by using "everyday" booleans and explaining the table beforehand.
2013-10-12 18:19:33 +02:00
d8ede4fddd
Closes #13203 : add a FAQ section about seemingly duplicate id()s.
2013-10-12 18:14:25 +02:00
8ee7708c7f
Issue #19005 : Fix documentation for PyIter_Next().
2013-10-09 22:42:46 -07:00
926099d5ce
#19194 : Improved cross-references in the fcntl module documentation.
2013-10-09 14:20:22 +03:00
7880db6136
#19196 : Improved cross-references in distutils documentation.
2013-10-09 14:09:16 +03:00
0d196edc37
Issue #19190 : Improve cross-references in builtin types and functions documentation.
2013-10-09 14:02:31 +03:00
0b68a2d675
Issue 19195: Improved cross-references in C API documentation.
2013-10-09 13:26:17 +03:00
91aaeac050
Issue #19193 : Improved cross-references in the tutorial.
2013-10-09 09:54:46 +03:00
ee82d0b293
Minor grammar fix.
2013-10-08 21:54:37 +02:00
0aaae26518
Clarify two points about division and shifting. Suggested by Albert Hofkamp on docs@.
2013-10-08 21:47:18 +02:00
f24c1416eb
Fix wrong link.
2013-10-08 21:43:39 +02:00
97f962339f
Add "->" as a delimiter token. Found by James Harding on docs@.
2013-10-08 21:28:22 +02:00
bcce1256e3
Closes #19178 : some more cross-references about packages in glossary. Patch by Berker Peksag.
2013-10-08 08:06:18 +02:00
c377fe2b96
Closes #1215 : document better why it is not a good idea to catch e.g. SIGSEGV and refer to faulthandler.
...
Patch by Martin Pool.
2013-10-06 21:22:42 +02:00
a072de14be
Extending example: use Py_RETURN_NONE
2013-10-06 20:46:08 +02:00
29fc4bf5c7
Use the platform-independent way of calling a script from the shell: "python prog.py", not "prog.py"
...
Found by Micheal Wells on docs@.
2013-10-06 19:33:56 +02:00
136a050bf3
Fix name of the "exist_ok" argument. Found by Neil Bushong on docs@.
2013-10-06 19:27:13 +02:00
9ad417ee81
Fix: >= and so on are usually called "comparison operators", not "logical operators". Found by Tom Kalt on docs@.
2013-10-06 19:23:57 +02:00
ac39addd72
Fix typo in example file name. Found by John Bokma on docs@.
2013-10-06 19:21:14 +02:00
6647a719bc
Fix: win32_ver returns a 4-tuple. Found by Andrew Berg on docs@.
2013-10-06 19:19:18 +02:00
f6d6347fc0
Fix typo in function name.
2013-10-06 19:14:35 +02:00
ffb94ae46f
Closes #15432 : GzipFile mtime argument is new in 3.1.
2013-10-06 19:02:08 +02:00
9ad5bf662d
Closes #15228 : remove reference to Unix "touch"; it is confusing since the path needs to exist for os.utime() to succeed
2013-10-06 18:57:49 +02:00
fc9a113418
Closes #11807 : document argparse add_subparsers method better.
...
Patch by Filip Gruszczyński.
2013-10-06 18:51:39 +02:00
c6a2c9b466
Closes #15213 : update comment for _PyOS_URandom
2013-10-06 18:43:19 +02:00
7d07833655
Closes #17725 : small grammar fix.
2013-10-06 18:36:34 +02:00
6e94a3098e
The "FAQ" link at the end was changed to a Wikipedia link; reflect that.
2013-10-06 18:26:36 +02:00
4a6cf6c9d1
Closes #19177 : replace dead link to SSL/TLS introduction with the version from Apache.
2013-10-06 18:20:31 +02:00
036e41de52
Closes #19181 : replace non-existing host ftp.cwi.nl with ftp.debian.org in ftplib example.
2013-10-06 18:17:56 +02:00
0bbbeb59f4
Closes #12350 : clarify blocks/block size members of stat result.
2013-10-06 18:11:32 +02:00
df40e860d3
Fix typo. Spotted by Bo Bayles on docs@.
2013-10-06 13:24:49 +02:00
1cef264326
Fix link to the "pexports" tool. Found by Joe Aikkaravelil on docs@.
2013-10-06 13:20:49 +02:00
9c2505b8fc
Fix order of required StreamReader/StreamWriter base classes. Spotted by Edward Welbourne on docs@.
2013-10-06 13:17:04 +02:00
49c6fc9679
Minor improvement: add indication that the main function goes on.
2013-10-06 13:14:10 +02:00
ed86ff868a
Fix missing class name in markup. Found by Tanky Woo on docs@.
2013-10-06 13:09:59 +02:00
e47e184c4a
Unicode howto: use .txt as a more universally understood extension for text files.
2013-10-06 13:07:10 +02:00
a12b682033
Add missing list methods. Found by Leonardo Pereira on docs@.
2013-10-06 13:01:19 +02:00
2070e83f28
Fix example in backreference description. Found by Alexander Heger on docs@.
2013-10-06 12:58:20 +02:00
a0b792354e
Fix method name: ensure_directories, not create_directories. Found by Michael Rand on docs@.
2013-10-06 12:52:49 +02:00
0688d68d14
PythonCAD is now on PyQt, use Wing as a prominent PyGtk example.
...
Found by Helge Stenström on docs@.
2013-10-06 12:46:13 +02:00
d277a56af3
Fix minor bug in httplib example. Found by Alex MacAulay on docs@.
2013-10-06 12:42:18 +02:00
3c1271142d
Fix SQLite datatype name: it is REAL, not FLOAT. Found by Richard Kelsall on docs@.
2013-10-06 12:38:44 +02:00
87f3d7bb54
Counter: fix recipe for "n least common elements". Found by Mikhail Golubev on docs@.
2013-10-06 12:36:39 +02:00
f27bfd81ec
Fix typo.
2013-10-06 12:33:20 +02:00
3c6780c6d8
Closes #15956 : improve documentation of named groups and how to reference them.
2013-10-06 12:08:14 +02:00
60e602dcc6
Fix small grammar mistake.
2013-10-06 11:57:13 +02:00
a710fdae1c
Fix missing period.
2013-10-06 11:12:29 +02:00
22a1fd75cc
Fix wrong Python highlighting in directory hierarchy code block.
2013-10-06 11:08:24 +02:00
337672b76c
Small clarification in extending docs.
2013-10-06 11:02:38 +02:00
b33c6eb640
Closes #13951 : Add a "faulthandler" reference in the ctypes docs talking about crashes.
2013-10-06 10:51:01 +02:00
b19ef1846c
Closes #18927 : Lock.acquire only accepts -1 or positive values for timeout.
2013-10-06 10:48:08 +02:00
242e6a0bce
Use "lambda expression" as preferred to "lambda form".
2013-10-06 10:28:39 +02:00
de5aff1bdc
Closes #18646 : improve lambda docs in tutorial. Original patch by Terry Reedy.
2013-10-06 10:22:45 +02:00
58d58dad56
Fix small copy-paste typo in ossaudiodev setparameters() example (found by Ken Housley on docs@).
2013-10-06 10:11:12 +02:00
dbab26a8c9
curses HOWTO: fix some PEP8 and a code example to actually raise the exception it promises.
2013-10-06 10:04:21 +02:00
f6324941f0
Clarify docs for os.path.getctime on Unix: it is the inode (metadata) change time
2013-10-06 09:52:55 +02:00
d2914ce0f7
Fix prefix_chars not being applied in help text example (reported by John Kooker on docs@)
2013-10-06 09:50:36 +02:00
74883a3751
Fix markup to not add parens to the "hashlib.md5" constructor when the object is meant, not the call.
2013-10-06 09:48:47 +02:00
a0ec296599
Remove newline in method that makes it possible to copy example to the interactive interpreter.
2013-10-06 09:42:46 +02:00
a84d473f02
Remove dead link to effbot Tkinter introduction material (reported by Ralf Ganswindt from docs@)
2013-10-06 09:32:03 +02:00
bdaee3ac95
Fix: Element.text is an attribute, not a method (report by Cameron Laird on docs@)
2013-10-06 09:23:03 +02:00
c2b17b2eba
Fix "customer timer" -> "custom timer" (reported by Kirk Strauser on docs@)
2013-10-06 09:17:43 +02:00
53bf15af47
Fix ZeroDivisionError message (reported by Pavel Fedotov on docs@)
2013-10-06 09:11:14 +02:00
5b22dd87aa
Close #19160 : Inconsistent size for GIL release in hashlib
2013-10-04 04:20:37 +02:00
f5c499e16c
Close #19160 : Inconsistent size for GIL release in hashlib
2013-10-04 04:15:06 +02:00
5c4b4c530f
[issue19152] Revert 832579dbafd6.
2013-10-03 15:03:29 -06:00
af8566c847
[issue19152] Add ExtensionFileLoader.get_filename().
2013-10-03 12:08:55 -06:00
21b2933456
Minor doc fix in urllib.parse.rst
2013-09-30 22:12:16 -07:00
1a67bee701
Add a "skull and crossbones" to Py_AddPendingCall.
2013-09-30 21:35:44 +02:00
587b30571d
Closes #19043 : remove detailed listing of versions from license files
...
Since all versions since 2.2 are under the same licensing terms,
this saves the release manager from touching the two files for
very new minor release.
2013-09-22 11:45:52 +02:00
2a97cee5ed
Correcting the mistake in 14ba90816930
...
Addresses Issue #18553 : isatty is not Unix only.
2013-09-19 00:08:56 -07:00
fb9dc0b3ae
Merge #14984 : On POSIX, enforce permissions when reading default .netrc.
2013-09-17 21:04:50 -04:00
8270a2c209
Merge #14984 : On POSIX, enforce permissions when reading default .netrc.
2013-09-17 20:32:54 -04:00
104aab956f
#14984 : On POSIX, enforce permissions when reading default .netrc.
...
Initial patch by Bruno Piguet.
This is implemented as if a useful .netrc file could exist without passwords,
which is possible in the general case; but in fact our netrc implementation
does not support it. Fixing that issue will be an enhancement.
2013-09-17 20:30:02 -04:00
560a77881b
#18951 : use consistent names in unittest docs.
2013-09-13 22:17:40 +03:00
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
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
Serhiy Storchaka
Georg Brandl
Nick Coghlan
Raymond Hettinger
Jesus Cea
Eric Snow
Senthil Kumaran
Antoine Pitrou
R David Murray
Ezio Melotti
Vinay Sajip
Eli Bendersky
Brett Cannon
Andrew Kuchling
David Wolever
Ned Deily
Felix Crux
Terry Jan Reedy
Victor Stinner
Barry Warsaw