Commit Graph

14646 Commits

Author SHA1 Message Date
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
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
R David Murray ce10fab9f6 #18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
2013-07-12 17:43:11 -04:00
Vinay Sajip 577d4ff6e0 Issue #18433: Clarified venv documentation. 2013-07-12 21:52:51 +01:00
Vinay Sajip ad6bb031d7 Issue #18434: Updated example script to tidy up resources. 2013-07-12 21:44:35 +01:00
Vinay Sajip 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 244d6252f2 Issue #18085: Add missed const modifier for some entries in refcounts.dat. 2013-07-11 21:57:34 +03:00
R David Murray 5a33f81348 #17987: properly document support.captured_xxx.
Patch by Dmi Baranov.
2013-07-11 12:28:40 -04:00
Serhiy Storchaka cca40ffa97 Issue #18336. Fix a link to StreamReader's read() method. 2013-07-11 18:26:13 +03:00
Ezio Melotti 93dd6934ff #18403: fix an off-by-one typo noticed by Xue Fuqiao. 2013-07-08 17:52:54 +02:00
Ronald Oussoren 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
Ronald Oussoren 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
Richard Oudkerk d7d3f376dd Issue #14206: Clarify docs for Queue.join_cancel_thread(). 2013-07-02 12:59:55 +01:00
Richard Oudkerk b3c4b98c23 Issue #17273: Clarify that pool methods can only be used by parent process. 2013-07-02 12:32:00 +01:00
Terry Jan Reedy 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
Terry Jan Reedy c4565a9524 Issue #18237: Fix assertRaisesRegexp error caought by Jeff Tratner. 2013-06-29 13:15:43 -04:00
R David Murray c7f7579855 #18311: fix typo. 2013-06-26 15:11:12 -04:00
Ned Deily 51cee7d24a Issue #18164: Clarify the embedding docs regarding link options. 2013-06-24 14:22:09 -07:00
Richard Oudkerk 2b310dd8b9 Fix typo. 2013-06-24 20:38:46 +01:00
Richard Oudkerk 7b69da72b8 Clarify note and fix typo. 2013-06-24 18:12:57 +01:00
Richard Oudkerk 64c25b4282 Issue #15818: Typo in docs. 2013-06-24 15:42:00 +01:00
Richard Oudkerk 95fe1a793f Issue #18277: Document quirks of multiprocessing queue. 2013-06-24 14:48:07 +01:00
R David Murray 021362dbd4 #18179: reflow paragraphs. 2013-06-23 16:05:44 -04:00
R David Murray 36beb66be9 #18179: document the local_hostname parameter.
Original patch by Berker Peksag.
2013-06-23 15:47:50 -04:00
Brett Cannon 29b2f174da Issue #18278: properly document how the loaders are called for FileFinder 2013-06-21 18:31:55 -04:00
Andrew Kuchling edb4260ffd Closes #18218: use correct variable name for starting point 2013-06-21 08:00:58 -04:00
Andrew Kuchling c3db3739aa Closes #18267: use floor division in code example 2013-06-20 21:33:05 -04:00
Andrew Kuchling 1d7d580d0e Closes #18272: use 'builtins' for 3.3 instead of __builtin__ 2013-06-20 21:17:41 -04:00
Andrew Kuchling 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
R David Murray 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
Brett Cannon a269d821a1 merge 2013-06-16 19:07:16 -04:00
Brett Cannon 1d75382e81 Fix a misnaming of a method and an argument 2013-06-16 19:06:55 -04:00
Andrew Kuchling 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
Ned Deily 3886120428 Issue #18187: Fix broken link in venv documentation. Patch by Berker Peksag. 2013-06-11 14:38:39 -07:00
Ezio Melotti c1f5839412 #18126: update NumPy links in the documentation. Patch by Yury V. Zaytsev. 2013-06-09 01:04:21 +03:00
Raymond Hettinger d71001749d Clarify which dictionaries are updateable
by using the wording from the Py2.7 docs.
2013-06-02 10:03:05 -07:00
Serhiy Storchaka dce05500a1 Issue #18085: Fix PyObject_CallMethodObjArgs()'s entry in refcounts.dat. 2013-05-28 22:46:15 +03:00
Serhiy Storchaka 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
Serhiy Storchaka fef952a607 Issue #18079: Fix a typo in the tutorial. 2013-05-28 12:49:34 +03:00
Jason R. Coombs 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
Ned Deily ecf0851809 Fix typo in embedding doc and update examples to 3.3. 2013-05-26 18:53:39 -07:00
Brett Cannon 4b4e38e7d4 Mention __cached__ in the import ref. 2013-05-25 11:32:50 -04:00
Brett Cannon 533f1ed334 Add a missing parenthesis. 2013-05-25 11:28:20 -04:00
Brett Cannon 2cefb3cf96 Various tweaks to importlib docs. 2013-05-25 11:26:11 -04:00