Commit Graph

19632 Commits

Author SHA1 Message Date
Vinay Sajip 41e9b401dc Issue #19455: Corrected inaccuracies in documentation and corrected some incorrect cross-references. 2013-10-31 01:08:59 +00:00
Christian Heimes db78e4365b fix language 2013-10-29 22:19:39 +01:00
Christian Heimes 88b2220859 Issue #18747: document issue with OpenSSL's CPRNG state and fork 2013-10-29 21:08:56 +01:00
Georg Brandl 712e951f54 Closes #19416: fix references in the nntplib docs. 2013-10-29 08:14:51 +01:00
Georg Brandl 21f2ec6aa4 Fix wrong signature for two-argument newwin(). Found by Jacqueline Leykam on docs@. 2013-10-29 08:10:36 +01:00
Georg Brandl b64f40f3e9 Fix typo: js_JP is not a valid locale. 2013-10-29 08:05:10 +01:00
Tim Golden 17934856dc Issue #15207: Fix mimetypes to read from correct area in Windows registry (Original patch by Dave Chambers) 2013-10-22 20:45:13 +01:00
Ezio Melotti c62403818c #19319: fix ctypes docs: sizeof is an operator in C, not a function. 2013-10-21 04:41:40 +03:00
Ezio Melotti cef2d49122 #19238, #19289: fix description of the align and fill values of the format specification. 2013-10-21 02:53:07 +03:00
Benjamin Peterson 97b36181db fix description of super() behavior on descriptors 2013-10-18 12:57:55 -04:00
Serhiy Storchaka de2f8fadcc Fix markup. 2013-10-18 11:54:52 +03:00
Georg Brandl cea38084eb Closes #19277: document all parameters of compressobj(). 2013-10-17 19:51:00 +02:00
Ezio Melotti 8ad0eac7ff #4965: Implement intelligent scrolling of the sidebar in the docs. 2013-10-14 22:01:28 +03:00
Serhiy Storchaka 0b9a9fd3a0 Issue #19189: Improved cross-references in the pickle module documentation. 2013-10-14 10:43:26 +03:00
Serhiy Storchaka b6f6450488 Merge heads 2013-10-13 23:29:53 +03:00
Georg Brandl b7557af86d Wing IDE is switching to PyQt... 2013-10-13 22:23:27 +02:00
Serhiy Storchaka b33336f650 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:00 +03:00
Serhiy Storchaka 7378d6374c Issue #19197: Improved cross-references in the shlex module documentation. 2013-10-13 21:17:56 +03:00
Serhiy Storchaka 361994c8e9 Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:25:30 +03:00
Georg Brandl 1b1c11d208 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 55c45c71cf Issue #19198: Improved cross-references in the cgi module documentation. 2013-10-13 18:27:51 +03:00
Georg Brandl 65e30a2db5 Closes #13740: SND_NOWAIT seems to be ignored on modern Windows. 2013-10-13 10:49:41 +02:00
Georg Brandl 6e5ae97c95 Closes #15829: document ThreadError and fix exception raised for releasing unlocked locks. 2013-10-13 10:23:27 +02:00
Georg Brandl 52fa1724ce Closes #14486: add versionchanged notices throughout the threading docs for PEP8-compliant APIs; the note at the top of the page is too hard to notice. 2013-10-13 10:07:31 +02:00
Georg Brandl 21721b6be5 Fix a small CSS glitch with deprecated blocks and Sphinx 1.2. 2013-10-13 09:56:20 +02:00
Georg Brandl 0aab3d97ad Fix display of deprecated blocks with Sphinx 1.2. 2013-10-13 09:31:42 +02:00
Georg Brandl af3ef9245c Fix compatibility with upcoming Sphinx 1.2. 2013-10-12 20:50:21 +02:00
Georg Brandl 5b68d64992 Closes #13905: mention rich-comparison methods in addition to __cmp__ when documenting how to make classes comparable and orderable. 2013-10-12 18:44:13 +02:00
Georg Brandl c2a9dc35c0 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 0f79cac1bf Closes #13203: add a FAQ section about seemingly duplicate id()s. 2013-10-12 18:14:25 +02:00
Raymond Hettinger 8b1701d394 Issue #19005: Fix documentation for PyIter_Next(). 2013-10-09 22:39:11 -07:00
Serhiy Storchaka 32dc141088 #19194: Improved cross-references in the fcntl module documentation. 2013-10-09 14:20:06 +03:00
Serhiy Storchaka a5ab7612c1 #19196: Improved cross-references in distutils documentation. 2013-10-09 14:09:02 +03:00
Serhiy Storchaka ad16b725bc Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:14 +03:00
Serhiy Storchaka 99a196fcfc Issue 19195: Improved cross-references in C API documentation. 2013-10-09 13:25:21 +03:00
Serhiy Storchaka 972788088d Issue #19193: Improved cross-references in the tutorial. 2013-10-09 09:54:32 +03:00
Georg Brandl 090588ec2c Minor grammar fix. 2013-10-08 21:54:37 +02:00
Georg Brandl e3e4c9afe4 Fix wrong link. 2013-10-08 21:43:39 +02:00
Georg Brandl 2808a1244d Closes #19178: backport entries for "module" and "package" from 3.x glossary. Patch by Berker Peksag. 2013-10-08 08:05:33 +02:00
Georg Brandl 9f57278251 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 3456d4746d Fix typo in example file name. Found by John Bokma on docs@. 2013-10-06 19:21:14 +02:00
Georg Brandl bab7850c8e Fix: win32_ver returns a 4-tuple. Found by Andrew Berg on docs@. 2013-10-06 19:19:18 +02:00
Georg Brandl 09289afbd4 Fix typo in function name. 2013-10-06 19:14:35 +02:00
Georg Brandl 188ddd3ba0 Closes #15432: GzipFile mtime argument was added in 2.7. 2013-10-06 19:01:21 +02:00
Georg Brandl 1f94b26cba Closes #11807: document argparse add_subparsers method better.
Patch by Filip Gruszczyński.
2013-10-06 18:51:39 +02:00
Georg Brandl c0edadee84 Closes #15213: update comment for _PyOS_URandom 2013-10-06 18:43:19 +02:00
Georg Brandl 4bfc96bf43 Closes #17725: small grammar fix. 2013-10-06 18:36:34 +02:00
Georg Brandl 917bb8cb34 The "FAQ" link at the end was changed to a Wikipedia link; reflect that. 2013-10-06 18:26:36 +02:00
Georg Brandl 4e8534e2ae Closes #19177: replace dead link to SSL/TLS introduction with the version from Apache. 2013-10-06 18:20:31 +02:00
Georg Brandl 60ccf0a8c9 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 5185d0f118 Closes #12350: clarify blocks/block size members of stat result. 2013-10-06 18:11:32 +02:00
Georg Brandl e0f6d59896 Fix link to the "pexports" tool. Found by Joe Aikkaravelil on docs@. 2013-10-06 13:20:49 +02:00
Georg Brandl 42dac47c96 Fix order of required StreamReader/StreamWriter base classes. Spotted by Edward Welbourne on docs@. 2013-10-06 13:17:04 +02:00
Georg Brandl e8c52e13ee Minor improvement: add indication that the main function goes on. 2013-10-06 13:14:10 +02:00
Georg Brandl e3005461c3 Fix missing class name in markup. Found by Tanky Woo on docs@. 2013-10-06 13:09:59 +02:00
Georg Brandl 980db0a098 Fix example in backreference description. Found by Alexander Heger on docs@. 2013-10-06 12:58:20 +02:00
Georg Brandl 5c80cc4486 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 d6896507da Fix minor bug in httplib example. Found by Alex MacAulay on docs@. 2013-10-06 12:42:18 +02:00
Georg Brandl 775ba9b424 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 97ea40aa6d Counter: fix recipe for "n least common elements". Found by Mikhail Golubev on docs@. 2013-10-06 12:36:39 +02:00
Georg Brandl d796cdb136 Fix typo. 2013-10-06 12:33:20 +02:00
Georg Brandl 75c3a0435c Fix strange deprecation version. 2013-10-06 12:31:06 +02:00
Georg Brandl ddbdc9a6e4 Closes #15956: improve documentation of named groups and how to reference them. 2013-10-06 12:08:14 +02:00
Georg Brandl bcc55d691e Fix small grammar mistake. 2013-10-06 11:57:13 +02:00
Georg Brandl b3d6fe336d Small logical fix in filter() example description. 2013-10-06 11:41:36 +02:00
Georg Brandl 96426886ec Clarify section about source code encoding. 2013-10-06 11:24:48 +02:00
Georg Brandl 6451ae6254 Fix missing period. 2013-10-06 11:12:29 +02:00
Georg Brandl f0f0843df3 Fix deprecated link to Python Testing Tools Taxonomy. Reported by Daniel Greenfeld on docs@. 2013-10-06 11:10:49 +02:00
Georg Brandl 76834a1a27 Fix merging mistake: wrong Python version. 2013-10-06 11:08:57 +02:00
Georg Brandl 15d9fe7ecf Fix wrong Python highlighting in directory hierarchy code block. 2013-10-06 11:08:24 +02:00
Georg Brandl b2efdee890 Small clarification in extending docs. 2013-10-06 11:02:38 +02:00
Georg Brandl cff39b0120 Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:26:58 +02:00
Georg Brandl d6d26ec908 Closes #18646: improve lambda docs in tutorial. Original patch by Terry Reedy. 2013-10-06 10:22:45 +02:00
Georg Brandl c5c900defb 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 c3eb868cc4 Fix some PEP8 in curses HOWTO. 2013-10-06 10:02:07 +02:00
Georg Brandl dc801844c1 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 2b38582e76 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 05c8baa40f Fix markup to not add parens to the "hashlib.md5" constructor when the object is meant, not the call. 2013-10-06 09:48:26 +02:00
Georg Brandl d39c3a4d45 Fix markup. 2013-10-06 09:47:45 +02:00
Georg Brandl baeb7f850a Remove dead link to effbot Tkinter introduction material (reported by Ralf Ganswindt from docs@) 2013-10-06 09:32:03 +02:00
Georg Brandl 5e7f16e77e 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 dc5f3fa85e Fix "customer timer" -> "custom timer" (reported by Kirk Strauser on docs@) 2013-10-06 09:17:43 +02:00
Ezio Melotti 8f89928b5a #19074: mention PySide in the GUI FAQs. 2013-10-06 01:02:09 +03:00
Benjamin Peterson 29f0dc5f77 dict is also allowed (closes #19163) 2013-10-04 10:55:15 -04:00
Senthil Kumaran 34f7c4ee80 Minor doc fix in urlparse.rst 2013-09-30 22:10:44 -07:00
Antoine Pitrou 59db34e4d5 Add a "skull and crossbones" to Py_AddPendingCall. 2013-09-30 21:35:44 +02:00
Georg Brandl a63231aa18 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
every new minor release.
2013-09-22 11:45:02 +02:00
Georg Brandl 110953d6de Closes #19061: make shelve security warning consistent between 2.x and 3.x. 2013-09-22 11:43:10 +02:00
R David Murray ba58e1d827 Merge: Add versionchanged for #14984, remove extra blank from string. 2013-09-17 20:10:23 -04:00
R David Murray 137b572d55 Add versionchanged for #14984, remove extra blank from string. 2013-09-17 20:08:09 -04:00
R David Murray 74213e4ee9 Merge #14984: On POSIX, enforce permissions when reading default .netrc. 2013-09-16 14:32:54 -04:00
R David Murray 4189b67a66 #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-16 13:48:44 -04:00
Ezio Melotti 802fa397d5 Fix markup in email.parser docs. 2013-09-13 22:55:08 +03:00
Ezio Melotti 36c3368233 #18951: use consistent names in unittest docs. 2013-09-13 22:17:40 +03:00
Senthil Kumaran b65685f3f2 Clarify mmap.close method behavior. Addresses issue #18815
Patch contributed by Anoop Thomas Mathew.
2013-09-09 22:38:58 -07:00
Senthil Kumaran cb7e5fa935 Correct Profile class usage example. Addresses issue #18033 .
Patch contributed by Olivier Hervieu and Dmi Baranov.
2013-09-07 17:50:35 -07:00
Senthil Kumaran 2646e6758d os.isatty is not Unix only. Correct the wrong documentation.
Addresses issue #18553
2013-09-07 11:27:45 -07:00
Ezio Melotti ad54307b9b #18895: split a sentence in unittest docs. 2013-09-07 15:23:36 +03:00
Ezio Melotti 2676583b66 #18894: remove mention of deprecated fail* methods. 2013-09-07 15:19:30 +03:00
Vinay Sajip 6971f2e6b7 Issue #18933: Added links to source code. 2013-09-05 22:57:20 +01:00
Benjamin Peterson b44c8619fe document that various functions that parse from source will interpret things as latin-1 (closes #18870) 2013-09-01 19:06:35 -04:00
Serhiy Storchaka 6d5bd5258c Issue #18743: Improved cross-references to the StringIO class. 2013-08-29 11:44:44 +03:00
Serhiy Storchaka 7653e26ecc Issue #18760: Improved cross-references in the xml package. 2013-08-29 10:34:23 +03:00
Serhiy Storchaka c8f26f500a Issue #18757: Improved cross-references in the concurrent package. 2013-08-24 00:28:38 +03:00
Charles-François Natali b817faa4ce Issue #15233: Python now guarantees that callables registered with the atexit
module will be called in a deterministic order.
2013-08-21 18:25:00 +02:00
Serhiy Storchaka f65d454a5e Issue #18761: Improved cross-references in email documentation. 2013-08-19 10:03:25 +03:00
Vinay Sajip 10b513098a Issue #18759: Improved cross-references in logging documentation. 2013-08-17 00:38:48 +01:00
Antoine Pitrou 79a16a85aa Issue #16190: fix random module recommendation to use ssl.RAND_bytes(). 2013-08-16 19:19:40 +02:00
David Wolever a80d3a09fd Issue #18718: datetime documentation contradictory on leap second support 2013-08-14 14:33:54 -04:00
Ned Deily 6681398ddd Issue 18724: Fix typo noticed by Susan Tan. 2013-08-13 01:11:56 -07:00
Felix Crux b4e186cf11 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 452dd38150 Issue #17701: Improving strftime documentation 2013-08-12 15:50:10 -04:00
Ezio Melotti d599142197 #18663: document that assertAlmostEqual also works when the values are equal and add tests. 2013-08-11 13:04:50 +03:00
Antoine Pitrou 92fae55bc9 Issue #18589: fix hyperlinking of type slots (tp_*) 2013-08-01 21:17:24 +02:00
Terry Jan Reedy 241f653b8a Remove repetition of string escapes note 1 at end of note 2. 2013-07-27 15:54:05 -04:00
R David Murray d5648ac382 #15130: remove repeat of abstract paragraph from socket howto body.
Patch by Tshepang Lekhonkhobe.
2013-07-25 13:33:35 -04:00
Vinay Sajip bcf55a758d Issue #18541: simplified LoggerAdapter example. 2013-07-24 17:47:52 +01:00
Ned Deily b7a285f528 Issue #18471: Fix typo in heapq documentation (reported by François Pinard). 2013-07-15 19:07:41 -07:00
Ned Deily c967a593c9 Issue #18452: fix several "occurrence" typos (reported by Févry Thibault). 2013-07-14 12:42:27 -07:00
R David Murray 4f0102f189 #18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
2013-07-12 18:21:41 -04:00
Serhiy Storchaka 6cda0adf3a Issue #18336. Fix a link to StreamReader's read() method. 2013-07-11 18:25:19 +03:00
Richard Oudkerk 4bc130c065 Issue #14206: Clarify docs for Queue.join_cancel_thread(). 2013-07-02 12:58:21 +01:00
Richard Oudkerk 4903253069 Issue #17273: Clarify that pool methods can only be used by parent process. 2013-07-02 12:31:50 +01:00
Terry Jan Reedy 44d8b11c3e 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:44 -04:00
Terry Jan Reedy 8d7500387d Issue #18237: Fix assertRaisesRegexp error caought by Jeff Tratner. 2013-06-29 13:15:36 -04:00
Terry Jan Reedy 35115e6aab Issue #18315: Improve fileinput docs by adding 'bufsize' where missing and
replacing redundant signature in input() docstring with one-line summary.
Original patch by Terrel Shumway.
2013-06-28 18:59:19 -04:00
Ned Deily 7dc9bd84df Issue #18164: Backport the more detailed embedding compile-and-link section
from the Python 3 documentation.
2013-06-24 14:21:43 -07:00
Richard Oudkerk 66e0a04d2e Fix typo. 2013-06-24 20:38:22 +01:00
Richard Oudkerk 2cc73e8e58 Clarify note and fix typo. 2013-06-24 18:11:21 +01:00
Richard Oudkerk acfbe22068 Issue #15818: Typo in docs. 2013-06-24 15:41:36 +01:00
Richard Oudkerk 56e968c50a Issue #18277: Document quirks of multiprocessing queue. 2013-06-24 14:45:24 +01:00
R David Murray 9575222b7f #18179: reflow paragraphs. 2013-06-23 16:10:37 -04:00
R David Murray 7f01d55333 #18179: document the local_hostname parameter.
Original patch by Berker Peksag.
2013-06-23 16:02:34 -04:00
R David Murray ff22984ff1 Tweak programming faq examples so that it (mostly) passes doctest.
Back port of 0113247f894b from 3.3.

The exceptions are the import related questions at the end, which
need to be rewritten anyway, and a math example that doesn't
exist in the 3.3+ docs that I didn't bother trying to fix.
2013-06-19 17:00:43 -04:00
Ezio Melotti c49805e967 #18126: update NumPy links in the documentation. Patch by Yury V. Zaytsev. 2013-06-09 01:04:21 +03:00
Serhiy Storchaka 3fcf2d3174 Issue #18085: Fix PyObject_CallMethodObjArgs()'s entry in refcounts.dat. 2013-05-28 22:46:51 +03:00
Raymond Hettinger 7393c69d6d Issue #18015: Fix unpickling of 2.7.3 and 2.7.4 namedtuples. 2013-05-27 10:58:55 -07:00
David Wolever c23ca48cce Clean merge 2013-05-23 17:51:58 -04:00
David Wolever bd9cbf0064 Clarify that strftime's encoding is based on locale 2013-05-23 17:42:14 -04:00
David Wolever db6d10a8bb Remove Japanese datetime examples 2013-05-23 17:23:49 -04:00
Raymond Hettinger 668b0058a3 Issue #18031: %-formatting isn't dead yet and might pull through. 2013-05-23 00:12:14 -07:00
Serhiy Storchaka 54f70923a3 Issue #17844: Refactor a documentation of Python specific encodings.
Add links to encoders and decoders for binary-to-binary codecs.
2013-05-22 15:28:30 +03:00
R David Murray e6f2e6cc84 #17973: fix technical inaccuracy in faq entry (it now passes doctest). 2013-05-21 11:46:18 -04:00
Ned Deily d7cb506789 Issue #18026: fix ctypes doc typo 2013-05-20 14:27:06 -07:00
R David Murray ed983ab8a9 #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:34:58 -04:00
Ezio Melotti 5302ba80e7 #17949: fix merge glitch in itemgetter signature. Patch by Martijn Pieters. 2013-05-10 19:57:04 +03:00
Andrew Kuchling 67f84a78f0 #14878: add cross-reference to the yield statement.
(Backported from 3.x by Jan Duzinkiewicz.)
2013-05-09 20:55:22 -04:00
Ezio Melotti 5f4ba6b4e0 #16523: improve attrgetter/itemgetter/methodcaller documentation. 2013-05-08 10:53:11 +03:00
Ezio Melotti 59391207c6 #17714: document that the base64 codec adds a trailing newline. 2013-05-07 11:14:27 +03:00
Raymond Hettinger a74e5c809b Issue 17920: Fix-up terminology in the set documentation 2013-05-06 18:21:10 -07:00