Commit Graph

14720 Commits

Author SHA1 Message Date
Ezio Melotti f5005883ba Fix broken link in html.entities docs. 2013-11-25 06:40:12 +02:00
Georg Brandl 44d2429a25 Doc/Makefile: also do "make suspicious" during daily autobuild 2013-11-24 16:17:54 +01:00
Zachary Ware e1391a0d68 Issue #18326: Clarify that list.sort's arguments are keyword-only.
Also, attempt to reduce confusion in the glossary by not saying there are
different "types" of arguments and parameters.
2013-11-22 13:58:34 -06:00
Andrew Kuchling 30c5ad2aa2 #1098749: re-word gettext docs to not encourage using pygettext so much.
Also, add a link to the Babel package.
2013-11-19 11:05:20 -05:00
Ezio Melotti e65cb190a6 Fix indentation in doc example. 2013-11-17 22:07:48 +02:00
Richard Oudkerk edcf8daaed Issue 16998: Clarify that += on a shared value is not atomic. 2013-11-17 17:00:38 +00:00
Antoine Pitrou 9eefe91fc2 Issue #19508: direct the user to read the security considerations for the ssl module 2013-11-17 15:35:33 +01:00
Ezio Melotti 2bbdfe7eda #19238: fix typo in documentation. 2013-11-17 02:47:12 +02:00
Vinay Sajip 9c10d6b800 Issue #19504: Used American spelling for 'customize'. 2013-11-15 20:58:13 +00:00
Andrew Kuchling 587e970be6 Update e-mail address 2013-11-12 10:02:35 -05:00
Jason R. Coombs 3492e39b44 Issue 19544 and Issue #7457: Restore the read_pkg_file method to distutils.dist.DistributionMetadata accidentally removed in the undo of distutils2. 2013-11-10 18:15:03 -05:00
R David Murray d5a2f0b3a1 #18985: Improve fcntl documentation.
Original patch by Vajrasky Kok, further improved (I hope) by me.
2013-11-07 10:51:07 -05:00
Vinay Sajip 2c1adcb62b Issue #18345: Added cookbook example illustrating handler customisation. 2013-11-05 10:02:21 +00:00
Tim Golden 834856aca9 Merge 2013-11-03 18:27:40 +00:00
Tim Golden 3a2abb5800 Issue #10197: Indicate availability of subprocess.get[status]output on Windows and add a note about the effects of universal newlines 2013-11-03 18:24:50 +00:00
R David Murray 5fdb64b5a0 #19411: Clarify that b2a_hex/hexlify returns a bytes object.
Initial patch by Vajrasky Kok.
2013-11-03 13:21:38 -05:00
Eli Bendersky 2915dd7103 Issue #19452: Clarify the documentation of iterparse w.r.t. events argument.
In 3.3 iterparse accepts a tuple in events (the C accelerator enforces this).
This limitation was lifted in Python 3.4
2013-10-31 05:53:39 -07:00
Vinay Sajip 9b83d533e2 Corrected some incorrect cross-references. 2013-10-31 01:10:30 +00:00
Christian Heimes 47674bc470 fix language 2013-10-29 22:19:39 +01:00
Christian Heimes 3046fe4c03 Issue #18747: document issue with OpenSSL's CPRNG state and fork 2013-10-29 21:08:56 +01:00
Georg Brandl 3d596fa90b Clarify sentence. 2013-10-29 08:16:56 +01:00
Georg Brandl 21527bf72f Closes #19416: fix references in the nntplib docs. 2013-10-29 08:14:51 +01:00
Georg Brandl 1ed80b09ed Fix wrong signature for two-argument newwin(). Found by Jacqueline Leykam on docs@. 2013-10-29 08:10:36 +01:00
Georg Brandl ad3215362c Fix typo: js_JP is not a valid locale. 2013-10-29 08:05:10 +01:00
Georg Brandl 325a1c2f37 Fix markup errors in the docs and amend suspicious ignores. 2013-10-27 09:16:01 +01:00
Georg Brandl bf3f8eb960 Issue #16037: HTTPMessage.readheaders() raises an HTTPException when more than
100 headers are read.  Adapted from patch by Jyrki Pulliainen.
2013-10-27 07:34:48 +01:00
Georg Brandl 72c98d3a76 Issue #17997: Change behavior of ``ssl.match_hostname()`` to follow RFC 6125,
for security reasons.  It now doesn't match multiple wildcards nor wildcards
inside IDN fragments.
2013-10-27 07:16:53 +01:00
Brett Cannon 6fd25c39c4 Issue #19392: Document that imp.reload() now relies on __loader__
being defined on top of __name__.
2013-10-25 13:46:15 -04:00
Tim Golden 27a856495e Issue #15207: Fix mimetypes to read from correct area in Windows registry (Original patch by Dave Chambers) 2013-10-22 19:27:34 +01:00
Ezio Melotti e45975080b #19319: fix ctypes docs: sizeof is an operator in C, not a function. 2013-10-21 04:41:40 +03:00
Ezio Melotti c318442571 #19238, #19289: fix description of the align and fill values of the format specification. 2013-10-21 02:53:07 +03:00
Benjamin Peterson 910a66566a fix description of super() behavior on descriptors 2013-10-18 12:57:55 -04:00
Serhiy Storchaka 335331311f Fix markup. 2013-10-18 11:55:02 +03:00
Georg Brandl 9ff06dcfad Fix inaccurate versionchanged tag for compressobj(): most parameter were there, just got kwarg support. 2013-10-17 19:51:34 +02:00
Serhiy Storchaka 5bbbc94073 Issue #19189: Improved cross-references in the pickle module documentation. 2013-10-14 10:43:46 +03:00
Ezio Melotti 47fd9d8e09 #4965: Implement intelligent scrolling of the sidebar in the docs. 2013-10-14 02:58:59 +03:00
Serhiy Storchaka 72aabb6177 Merge heads 2013-10-13 23:27:23 +03:00
Georg Brandl 810f1d56ea Wing IDE is switching to PyQt... 2013-10-13 22:23:27 +02:00
Georg Brandl c3a2916919 Closes #19248: actually check for Python 3.x in tools/sphinx-build.py. 2013-10-13 22:19:49 +02:00
Serhiy Storchaka bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Serhiy Storchaka 4e985673bf Issue #19197: Improved cross-references in the shlex module documentation. 2013-10-13 21:19:00 +03:00
Serhiy Storchaka dab8354920 Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:12:43 +03:00
Serhiy Storchaka 5e1c053f0c Improve #19204: Improved cross-references in the urllib package documentation. 2013-10-13 20:06:50 +03:00
Georg Brandl 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
Serhiy Storchaka 04d11a73fa Issue #19203: Improved cross-references in the curses howto. 2013-10-13 18:51:59 +03:00
Serhiy Storchaka fd1c3d3059 Issue #19198: Improved cross-references in the cgi module documentation. 2013-10-13 18:28:26 +03:00
Nick Coghlan 6cb2b5b1e1 Issue #17827: Document codecs.encode and codecs.decode 2013-10-14 00:22:13 +10:00
Georg Brandl aeaecfd257 Closes #13740: SND_NOWAIT seems to be ignored on modern Windows. 2013-10-13 10:49:41 +02:00
Georg Brandl 5d5b375c84 Fix a small CSS glitch with deprecated blocks and Sphinx 1.2. 2013-10-13 09:56:20 +02:00
Georg Brandl 1e32011306 Fix display of deprecated blocks with Sphinx 1.2. 2013-10-13 09:31:42 +02:00
Raymond Hettinger 64801680d3 Issue #19202: Add cross-reference and a rough code equivalent 2013-10-12 16:04:17 -07:00
Georg Brandl a14034872b Invert logic of new limited-API annotation and call it "stable ABI". 2013-10-12 22:55:34 +02:00
Georg Brandl 239990daec Fix compatibility with upcoming Sphinx 1.2. 2013-10-12 20:50:21 +02:00
Georg Brandl 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
Georg Brandl 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
Georg Brandl ae30a813a9 Closes #13833: document PyStructSequence C-API functions. 2013-10-12 19:03:43 +02:00
Georg Brandl c96ef1f0ed Closes #13026: fix documentation of MAKE_FUNCTION for 3.x. 2013-10-12 18:41:18 +02:00
Georg Brandl 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
Georg Brandl d8ede4fddd Closes #13203: add a FAQ section about seemingly duplicate id()s. 2013-10-12 18:14:25 +02:00
Raymond Hettinger 8ee7708c7f Issue #19005: Fix documentation for PyIter_Next(). 2013-10-09 22:42:46 -07:00
Serhiy Storchaka 926099d5ce #19194: Improved cross-references in the fcntl module documentation. 2013-10-09 14:20:22 +03:00
Serhiy Storchaka 7880db6136 #19196: Improved cross-references in distutils documentation. 2013-10-09 14:09:16 +03:00
Serhiy Storchaka 0d196edc37 Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:31 +03:00
Serhiy Storchaka 0b68a2d675 Issue 19195: Improved cross-references in C API documentation. 2013-10-09 13:26:17 +03:00
Serhiy Storchaka 91aaeac050 Issue #19193: Improved cross-references in the tutorial. 2013-10-09 09:54:46 +03:00
Georg Brandl ee82d0b293 Minor grammar fix. 2013-10-08 21:54:37 +02:00
Georg Brandl 0aaae26518 Clarify two points about division and shifting. Suggested by Albert Hofkamp on docs@. 2013-10-08 21:47:18 +02:00
Georg Brandl f24c1416eb Fix wrong link. 2013-10-08 21:43:39 +02:00
Georg Brandl 97f962339f Add "->" as a delimiter token. Found by James Harding on docs@. 2013-10-08 21:28:22 +02:00
Georg Brandl bcce1256e3 Closes #19178: some more cross-references about packages in glossary. Patch by Berker Peksag. 2013-10-08 08:06:18 +02:00
Georg Brandl 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
Georg Brandl a072de14be Extending example: use Py_RETURN_NONE 2013-10-06 20:46:08 +02:00
Georg Brandl 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
Georg Brandl 136a050bf3 Fix name of the "exist_ok" argument. Found by Neil Bushong on docs@. 2013-10-06 19:27:13 +02:00
Georg Brandl 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
Georg Brandl ac39addd72 Fix typo in example file name. Found by John Bokma on docs@. 2013-10-06 19:21:14 +02:00
Georg Brandl 6647a719bc Fix: win32_ver returns a 4-tuple. Found by Andrew Berg on docs@. 2013-10-06 19:19:18 +02:00
Georg Brandl f6d6347fc0 Fix typo in function name. 2013-10-06 19:14:35 +02:00
Georg Brandl ffb94ae46f Closes #15432: GzipFile mtime argument is new in 3.1. 2013-10-06 19:02:08 +02:00
Georg Brandl 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
Georg Brandl fc9a113418 Closes #11807: document argparse add_subparsers method better.
Patch by Filip Gruszczyński.
2013-10-06 18:51:39 +02:00
Georg Brandl c6a2c9b466 Closes #15213: update comment for _PyOS_URandom 2013-10-06 18:43:19 +02:00
Georg Brandl 7d07833655 Closes #17725: small grammar fix. 2013-10-06 18:36:34 +02:00
Georg Brandl 6e94a3098e The "FAQ" link at the end was changed to a Wikipedia link; reflect that. 2013-10-06 18:26:36 +02:00
Georg Brandl 4a6cf6c9d1 Closes #19177: replace dead link to SSL/TLS introduction with the version from Apache. 2013-10-06 18:20:31 +02:00
Georg Brandl 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
Georg Brandl 0bbbeb59f4 Closes #12350: clarify blocks/block size members of stat result. 2013-10-06 18:11:32 +02:00
Georg Brandl df40e860d3 Fix typo. Spotted by Bo Bayles on docs@. 2013-10-06 13:24:49 +02:00
Georg Brandl 1cef264326 Fix link to the "pexports" tool. Found by Joe Aikkaravelil on docs@. 2013-10-06 13:20:49 +02:00
Georg Brandl 9c2505b8fc Fix order of required StreamReader/StreamWriter base classes. Spotted by Edward Welbourne on docs@. 2013-10-06 13:17:04 +02:00
Georg Brandl 49c6fc9679 Minor improvement: add indication that the main function goes on. 2013-10-06 13:14:10 +02:00
Georg Brandl ed86ff868a Fix missing class name in markup. Found by Tanky Woo on docs@. 2013-10-06 13:09:59 +02:00
Georg Brandl e47e184c4a Unicode howto: use .txt as a more universally understood extension for text files. 2013-10-06 13:07:10 +02:00
Georg Brandl a12b682033 Add missing list methods. Found by Leonardo Pereira on docs@. 2013-10-06 13:01:19 +02:00
Georg Brandl 2070e83f28 Fix example in backreference description. Found by Alexander Heger on docs@. 2013-10-06 12:58:20 +02:00
Georg Brandl a0b792354e Fix method name: ensure_directories, not create_directories. Found by Michael Rand on docs@. 2013-10-06 12:52:49 +02:00
Georg Brandl 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
Georg Brandl d277a56af3 Fix minor bug in httplib example. Found by Alex MacAulay on docs@. 2013-10-06 12:42:18 +02:00
Georg Brandl 3c1271142d Fix SQLite datatype name: it is REAL, not FLOAT. Found by Richard Kelsall on docs@. 2013-10-06 12:38:44 +02:00
Georg Brandl 87f3d7bb54 Counter: fix recipe for "n least common elements". Found by Mikhail Golubev on docs@. 2013-10-06 12:36:39 +02:00
Georg Brandl f27bfd81ec Fix typo. 2013-10-06 12:33:20 +02:00
Georg Brandl 3c6780c6d8 Closes #15956: improve documentation of named groups and how to reference them. 2013-10-06 12:08:14 +02:00
Georg Brandl 60e602dcc6 Fix small grammar mistake. 2013-10-06 11:57:13 +02:00
Georg Brandl a710fdae1c Fix missing period. 2013-10-06 11:12:29 +02:00
Georg Brandl 22a1fd75cc Fix wrong Python highlighting in directory hierarchy code block. 2013-10-06 11:08:24 +02:00
Georg Brandl 337672b76c Small clarification in extending docs. 2013-10-06 11:02:38 +02:00
Georg Brandl b33c6eb640 Closes #13951: Add a "faulthandler" reference in the ctypes docs talking about crashes. 2013-10-06 10:51:01 +02:00
Georg Brandl b19ef1846c Closes #18927: Lock.acquire only accepts -1 or positive values for timeout. 2013-10-06 10:48:08 +02:00
Georg Brandl 242e6a0bce Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:28:39 +02:00
Georg Brandl de5aff1bdc Closes #18646: improve lambda docs in tutorial. Original patch by Terry Reedy. 2013-10-06 10:22:45 +02:00
Georg Brandl 58d58dad56 Fix small copy-paste typo in ossaudiodev setparameters() example (found by Ken Housley on docs@). 2013-10-06 10:11:12 +02:00
Georg Brandl 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
Georg Brandl f6324941f0 Clarify docs for os.path.getctime on Unix: it is the inode (metadata) change time 2013-10-06 09:52:55 +02:00
Georg Brandl 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
Georg Brandl 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
Georg Brandl a0ec296599 Remove newline in method that makes it possible to copy example to the interactive interpreter. 2013-10-06 09:42:46 +02:00
Georg Brandl a84d473f02 Remove dead link to effbot Tkinter introduction material (reported by Ralf Ganswindt from docs@) 2013-10-06 09:32:03 +02:00
Georg Brandl bdaee3ac95 Fix: Element.text is an attribute, not a method (report by Cameron Laird on docs@) 2013-10-06 09:23:03 +02:00
Georg Brandl c2b17b2eba Fix "customer timer" -> "custom timer" (reported by Kirk Strauser on docs@) 2013-10-06 09:17:43 +02:00
Georg Brandl 53bf15af47 Fix ZeroDivisionError message (reported by Pavel Fedotov on docs@) 2013-10-06 09:11:14 +02:00
Jesus Cea 5b22dd87aa Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:20:37 +02:00
Jesus Cea f5c499e16c Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:15:06 +02:00
Eric Snow 5c4b4c530f [issue19152] Revert 832579dbafd6. 2013-10-03 15:03:29 -06:00
Eric Snow af8566c847 [issue19152] Add ExtensionFileLoader.get_filename(). 2013-10-03 12:08:55 -06:00
Senthil Kumaran 21b2933456 Minor doc fix in urllib.parse.rst 2013-09-30 22:12:16 -07:00
Antoine Pitrou 1a67bee701 Add a "skull and crossbones" to Py_AddPendingCall. 2013-09-30 21:35:44 +02:00
Georg Brandl 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
Senthil Kumaran 2a97cee5ed Correcting the mistake in 14ba90816930
Addresses Issue #18553: isatty is not Unix only.
2013-09-19 00:08:56 -07:00
R David Murray fb9dc0b3ae Merge #14984: On POSIX, enforce permissions when reading default .netrc. 2013-09-17 21:04:50 -04:00
R David Murray 8270a2c209 Merge #14984: On POSIX, enforce permissions when reading default .netrc. 2013-09-17 20:32:54 -04:00
R David Murray 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
Ezio Melotti 560a77881b #18951: use consistent names in unittest docs. 2013-09-13 22:17:40 +03:00
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