Commit Graph

17032 Commits

Author SHA1 Message Date
Terry Jan Reedy d986563a06 Issue #22155: Add File Handlers subsection with createfilehandler to tkinter
doc.  Remove obsolete example from FAQ.  Patch by Martin Panter.
2015-05-17 14:49:26 -04:00
R David Murray 0e8168c9e5 #24216: fix typo 2015-05-17 10:16:37 -04:00
Yury Selivanov 82796193f9 Issue 24191: Document BoundArguments.signature 2015-05-14 14:14:02 -04:00
R David Murray 2249d9f7d6 Make sentence correct English. 2015-05-14 08:50:38 -04:00
R David Murray 0a560a11af #23088: Clarify null termination of bytes and strings in C API.
Patch by Martin Panter, reviewed by Serhiy Storchaka and R. David Murray.
2015-05-13 20:31:53 -04:00
Raymond Hettinger 3afdb2870f Fix mangled wording 2015-05-13 14:39:04 -07:00
Raymond Hettinger a3780259e4 Issue #19934: Document *None* as an acceptable input to Counter.most_common([n]) 2015-05-13 02:47:57 -07:00
Benjamin Peterson 19a3f17cb3 use imperative 2015-05-12 19:15:53 -04:00
Berker Peksag c2dd680115 Issue #23983: Update the pty module example.
Changes:

* Fixed a ResourceWarning warning
* Used argparse instead of getopt
2015-05-12 17:25:06 +03:00
Yury Selivanov d7e19bb566 docs/asyncio: Document new ensure_future() and deprecated async() 2015-05-11 16:33:41 -04:00
Yury Selivanov 7185461897 docs/asyncio: Document set_task_factory/get_task_factory 2015-05-11 16:28:27 -04:00
Andrew Svetlov b79e01248d Fix doc: asyncio.Semaphore.release() actually is a regular function, not coroutine 2015-05-08 14:13:41 +03:00
Benjamin Peterson ad643b59ce remove word we don't need 2015-05-06 21:29:14 -04:00
Zachary Ware 828946e561 Fix copy/paste errors.
Basically, s/thread/coroutine/.
2015-05-06 20:19:06 -05:00
Guido van Rossum d0150ad59e Issue 24088: Clarify semantics of yield expression. 2015-05-05 12:02:01 -07:00
Benjamin Peterson ac87ed7e9f update example, since python.org is HTTPS-only now (closes #24118) 2015-05-03 12:59:09 -04:00
R David Murray 4590c3d944 #24108: Update fnmatch.translate example to show correct output.
Patch by Merlijn van Deen.
2015-05-02 15:08:22 -04:00
R David Murray 6d877ef026 #24081: Remove obsolete caveat from import docs.
Per Eric Snow's research, this changed in Python 2.4 in changeset 331e60d8ce,
but these docs were not updated.

Patch by Peter Viktorin.
2015-05-02 14:57:54 -04:00
Serhiy Storchaka a7db0576ac Fixed a typo. 2015-05-02 19:24:41 +03:00
Vinay Sajip bbd95a9361 Issue #24060: Made logging.Formatter documentation a little clearer. 2015-05-02 09:46:05 +01:00
Berker Peksag 2034caa0c4 Issue #24062: Fix os.stat links. Patch by July Tikhonov. 2015-04-27 13:53:28 +03:00
Berker Peksag 8c99a6d604 Issue #23356: Simplify convert_arg_line_to_args example.
Patch by py.user.
2015-04-26 12:09:54 +03:00
Benjamin Peterson d87dd434c0 fix relative link (closes #24057) 2015-04-25 14:15:16 -04:00
Benjamin Peterson 9bdd61338d remove dead *-import checking code (closes #24049) 2015-04-24 12:02:29 -04:00
Barry Warsaw 2097f53ec3 Issue #24029: Document the name binding behavior for submodule imports. 2015-04-22 18:29:16 -04:00
Andrew Kuchling 333518e01d #15183: clarify timeit documentation to say that setup statement isn't timed 2015-04-21 19:43:33 -04:00
Benjamin Peterson 6de708fd46 recommend requests library (closes #23989)
Patch from Van Lindberg
2015-04-20 18:18:14 -04:00
Benjamin Peterson cdbe29902e fix grammar 2015-04-19 23:14:37 -04:00
Berker Peksag 37de910b52 Mark TarInfo.frombuf() and TarInfo.fromtarfile() as classmethods. 2015-04-19 04:37:35 +03:00
Berker Peksag e4dde50c78 Issue #15566: Document encoding and errors parameters of TarInfo.frombuf().
Patch by Andy Holst.
2015-04-19 04:32:23 +03:00
Vinay Sajip 2d965c2555 Issue #23536: Clarified scope of fileConfig()'s API. 2015-04-18 13:14:10 +01:00
R David Murray 5be7f1513d #23957: fix typo. 2015-04-14 16:42:08 -04:00
Gregory P. Smith 0f2f3bc9db issue9014: Include more formatting on :c:type:`PyObject` etc. 2015-04-14 11:21:05 -07:00
Gregory P. Smith 1b24465c93 issue9014: Properly document PyObject_HEAD and friends post-PEP-3123. 2015-04-14 11:12:53 -07:00
Gregory P. Smith 23a6a0daa1 remove trailing space :) 2015-04-14 10:04:30 -07:00
Gregory P. Smith f2a448a66b issue22046: mention that zipfile can raise NotImplementedError on unsupported
compression algorithms.
2015-04-14 10:02:20 -07:00
Berker Peksag 4882cacab6 Issue #23943: Fix typos. Patch by Piotr Kasprzyk. 2015-04-14 09:30:01 +03:00
Zachary Ware ae9f0fede3 Issue #23730: Document the return value of ZipFile.extract
Patch by Stéphane Wirtel.
2015-04-13 16:40:49 -05:00
Antoine Pitrou 97aa953550 Fix duplicate doc entry for SSLContext.get_ca_certs()
(closes #18147)
2015-04-13 21:06:15 +02:00
Zachary Ware 4c9c848159 Issue #17202: Add .bat to .hgeol to force them to CRLF.
Using LF can a script to fail if it tries to use a label that is
split across 512 byte blocks.  Who knows why.
2015-04-13 11:59:54 -05:00
Zachary Ware f3b990e48c Issue #23932: Update the tutorial section on function annotations.
Patch by Juti Noppornpitak.
2015-04-13 11:30:47 -05:00
R David Murray 354c7403c5 #17380: Document tp_init return value in extending docs.
Patch by James Powell.
2015-04-12 21:51:36 -04:00
Berker Peksag 9575e1891f Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Antoine Pitrou 8ad751e024 Close #23904: fix pathlib documentation misleadingly mentioning that bytes objects are accepted in the PurePath constructor 2015-04-12 00:08:02 +02:00
Berker Peksag 770319d6bd Issue #23912: Fix code formatting in datamodel.rst.
Patch by James Edwards.
2015-04-11 14:59:30 +03:00
Benjamin Peterson 1c69c3e3d8 use imperative 2015-04-11 07:42:42 -04:00
Berker Peksag eb7a97c48e Issue #23025: Add a mention of os.urandom to RAND_bytes and RAND_pseudo_bytes docs.
Patch by Alex Gaynor.
2015-04-10 16:19:13 +03:00
Tim Golden fe5ac52c2b Fix typo in telnet docs (reported by Keith Briggs) 2015-04-08 16:52:27 +01:00
Benjamin Peterson 6f362fa6c8 actually ssl3 is just completely broken 2015-04-08 11:11:00 -04:00
Berker Peksag 7ecfc82edb Issue #23400: Raise same exception on both Python 2 and 3 if sem_open is not available.
Patch by Davin Potts.
2015-04-08 17:56:30 +03:00
Tim Golden 42c235e833 Added missing right bracket (reported by Daryl Klakouski) 2015-04-06 11:04:49 +01:00
Victor Stinner 72dcb0a765 Issue #23219: Update asyncio.wait_for() documentation
the wait is cancelled, the future *fut* is now also cancelled.
2015-04-03 17:08:19 +02:00
Benjamin Peterson 8218bd4caf document what exactly str.splitlines() splits on (closes #12855)
Patch by Martin Panter.
2015-03-31 21:20:36 -04:00
Raymond Hettinger c43a666ba2 Issue #23729: Improve docs for ElementTree namespace parsing 2015-03-30 20:29:28 -07:00
Ezio Melotti 2e3998fae0 #11468: improve unittest basic example. Initial patch by Florian Preinstorfer. 2015-03-24 12:42:41 +02:00
Raymond Hettinger f6e31b79a8 Issue 23729: Document ElementTree namespace handling and fix an omission in the XPATH predicate table. 2015-03-22 15:29:09 -07:00
R David Murray beed8402ca #23539: Set Content-Length to 0 for PUT, POST, and PATCH if body is None.
Some http servers will reject PUT, POST, and PATCH requests if they
do not have a Content-Length header.

Patch by James Rutherford, with additional cleaning up of the
'request' documentation by me.
2015-03-22 15:18:23 -04:00
Benjamin Peterson 218144a94d clarify behavior of shutil.move when destination exists (closes #22933)
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
R David Murray 63998a3520 #11726: Make linecache docs reflect that all files are treated the same.
Being able to read non-python text files is not a purpose of linecache, but it
does work and people use it.  This changeset adjusts the language to make it
clear that Python files are not treated uniquely, but does not go so far as to
say reading non-python files is explicitly supported.
2015-03-20 11:31:38 -04:00
Victor Stinner 376658fa13 Issue #11726: Fix linecache example in the doc
Use a Python source file (linecache.__file__) instead of /etc/passwd.

Modify also linecache docstrings to clarify the linecache is written to cache
Python source files, not any text files.
2015-03-18 14:16:50 +01:00
Victor Stinner 93f0665fb6 Issue #11726: clarify linecache doc: linecache is written to cache Python
source files, even if "it works" with other text files encoded to UTF-8.
2015-03-18 14:14:42 +01:00
Victor Stinner 6a318d420a Issue #19428: Document that PyMarshal_ReadLongFromFile() and
PyMarshal_ReadShortFromFile() can fail.
2015-03-18 13:58:49 +01:00
Berker Peksag 6a98002d47 Issue #23682: Delete Python 2.2 mention from distutils documentation.
Patch by Thomas Kluyver.
2015-03-17 06:55:48 +02:00
Benjamin Peterson 59c4eb71f2 versionchanged for rc4 removal (closes #23679) 2015-03-16 12:43:38 -05:00
Eli Bendersky 39430daa3b Issue #23549: Clarify confusion in heapq doc - accessing the mininmal element
The current documentation only mentions heap[0] as the smallest element in the
beginning, and not in any of the methods' docs. There's no method to access the
minimal element without popping it, and the documentation of nsmallest is
confusing because it may suggest that min() is the way to go for n==1.
2015-03-14 20:14:23 -07:00
Serhiy Storchaka b19542d062 Fix minor docs markup errors. 2015-03-14 21:32:57 +02:00
Benjamin Peterson 0d70ab6b8c __getslice__ certainly won't appear in the output 2015-03-13 16:21:23 -05:00
Brett Cannon 2645bad04f Make the case to only support Python 2.7 when supporting 2/3 simultaneously 2015-03-13 12:49:44 -04:00
Benjamin Peterson f0f14f72bb use the meth role for ZipFile.open 2015-03-12 22:41:06 -05:00
Berker Peksag 32799953b0 Issue #23081: Document that PySequence_List also accepts iterables.
Patch by Lars Buitinck.
2015-03-13 02:55:45 +02:00
Berker Peksag ce77ee9183 Issue #22154: Add an example to show context management protocol support of ZipFile.open().
Patch by Mike Short.
2015-03-13 02:29:54 +02:00
Serhiy Storchaka a60c2fe480 Issue #23641: Cleaned out legacy dunder names from tests and docs.
Fixed 2 to 3 porting bug in pynche.ColorDB.
2015-03-12 21:56:08 +02:00
Victor Stinner 84c717dd9e asyncio doc: changes on the Queue API missed Python 3.4.3 release 2015-03-10 16:27:54 +01:00
Berker Peksag 77a6b20a35 Issue #23432: Remove duplicate content from SystemExit docs.
Also, document SystemExit.code attribute explicitly.
2015-03-10 14:47:15 +02:00
Victor Stinner 47c41b4e4d Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example 2015-03-10 13:31:47 +01:00
Ned Deily 8be2142377 Issue #23617: Correct plurals typo noted by Kentrell Johnson. 2015-03-09 01:55:02 -07:00
Benjamin Peterson c8358273ae indicate correct version (closes #23608) 2015-03-08 09:42:25 -04:00
Benjamin Peterson 8c69ecf95d replace Amazon links in the documentation (closes #23579)
Patch by Sayan Chowdhury.
2015-03-07 09:34:16 -05:00
Benjamin Peterson 990fcaac3c expose X509_V_FLAG_TRUSTED_FIRST 2015-03-04 22:49:41 -05:00
Benjamin Peterson bdf525b77c wrap everything at 80 chars 2015-03-02 09:31:40 -05:00
Benjamin Peterson 29fec92875 link to the correct dis method or function (closes #23561) 2015-03-02 09:27:43 -05:00
Berker Peksag ab4040e3c6 Issue #20521: Change ``TOS`` to TOS in dis documentation.
TOS is an abbreviation of top-of-stack.

Patch by Sven Berkvens-Matthijsse.
2015-03-02 06:33:30 +02:00
Brett Cannon fdde79dbf6 Fix the clarification as to why division cannot be ported automatically 2015-02-27 15:10:03 -05:00
Zachary Ware 0b49637890 Fix copy/paste error in bytes.isupper() doc.
Reported by Jon Colburn on docs@.
2015-02-27 01:40:22 -06:00
Victor Stinner 7b2c3c6840 asyncio doc: lock classes are not thread safe 2015-02-26 10:39:16 +01:00
Berker Peksag f9e3cf1f9f Issue #23511: Port email-simple.py to Python 3.
Also, update email examples to use the context manager version of open().

Patch by Baptiste Mispelon.
2015-02-25 18:14:09 +02:00
Victor Stinner 83704963c0 asyncio: add a note about (non) thread safety in each class 2015-02-25 14:24:15 +01:00
Victor Stinner 532c69a428 asyncio doc: begin with warnings on asyncio traps 2015-02-25 14:23:51 +01:00
Victor Stinner 615a58eaab asyncio doc: move queues to a new page 2015-02-25 13:55:43 +01:00
Georg Brandl 7e91af3a91 Remove unsupported (in latex) character from the source. 2015-02-25 13:05:53 +01:00
Victor Stinner b8064a8a16 asyncio doc: close explicitly event loops 2015-02-23 11:41:56 +01:00
Ned Deily 75790938a4 Issue #23499: Fix grammar error noticed by SilentGhost 2015-02-22 16:14:32 -08:00
Serhiy Storchaka a3369a524c Issues #814253, #9179: Warnings now are raised when group references and
conditional group references are used in lookbehind assertions in regular
expressions.
2015-02-21 12:08:52 +02:00
Berker Peksag babc688180 Issue #23439: Add missing entries to http.client.__all__.
Also, document the LineTooLong exception since it can be raised by
the members of public API (e.g. http.client.HTTPResponse).

Patch by Martin Panter.
2015-02-20 09:39:38 +02:00
Zachary Ware 56dee1e463 Fix typo pointed out on docs@ by Yaniv Sayeh 2015-02-19 22:30:15 -06:00
Zachary Ware 57c616f1e4 Fix a typo pointed out on docs@ 2015-02-19 22:15:36 -06:00
Benjamin Peterson 70e2847347 document the requestline and close_connection attributes, use real booleans, and add tests (closes #23410)
Patch by Martin Panter.
2015-02-17 21:11:10 -05:00
Victor Stinner f91d845797 asyncio, Tulip issue 220: Update doc of asyncio.Queue, add join and task_done
methods
2015-02-17 23:09:52 +01:00
Victor Stinner e170ed27c6 asyncio doc: fix the sphinx extension for coroutine commands 2015-02-17 23:08:35 +01:00
Serhiy Storchaka df0db49b1b Issue #22883: Update PyInt to PyLong in C API example. 2015-02-17 10:18:44 +02:00