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
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
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
Berker Peksag
4d6c6063bf
Fix typo in os.supports_effective_ids documentation.
2015-02-16 03:36:10 +02:00
Berker Peksag
50ef8a8e67
Issue #13637 : Remove outdated versionchanged directives.
...
Patch by Martin Panter.
2015-02-15 00:05:42 +02:00
Victor Stinner
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
Ned Deily
50afcc09ac
Fix missing :ref: for idle in doc build.
2015-02-06 15:42:06 +11:00
Victor Stinner
6a1b004b83
asyncio doc: explain how to display ResourceWarning in the debug mode section
2015-02-04 16:14:33 +01:00
Victor Stinner
17d87f8ae4
asyncio, Tulip issue 221: Fix doc of QueueEmpty and QueueFull
2015-02-03 15:09:24 +01:00
Serhiy Storchaka
c057c3859c
Issue #23099 : Closing io.BytesIO with exported buffer is rejected now to
...
prevent corrupting exported buffer.
2015-02-03 02:00:18 +02:00
R David Murray
756f0b1982
Fix asyncio doc typo.
2015-01-29 19:53:33 -05:00
Victor Stinner
188f2c0b75
asyncio doc: document the new ResourceWarning warnings
2015-01-30 01:35:14 +01:00
Victor Stinner
1077dee457
asyncio doc: add a section about task cancellation
2015-01-30 00:55:58 +01:00
Victor Stinner
7a55b88d9c
Issue #21962 , asyncio doc: Suggest the usage of wait_for() to replace
...
the lack of timeout parameter for locks and queues.
2015-01-30 00:37:04 +01:00
Victor Stinner
54a231d539
asyncio doc: document Protocol state machine
2015-01-29 13:33:15 +01:00
Serhiy Storchaka
b76bcc4ffc
Issue #14099 : Backout changeset e5bb3044402b (except adapted tests).
2015-01-26 13:45:39 +02:00
Serhiy Storchaka
2bef58577f
Issue #18518 : timeit now rejects statements which can't be compiled outside
...
a function or a loop (e.g. "return" or "break").
2015-01-26 12:09:17 +02:00
R David Murray
1923b627b5
#23215 : reflow paragraph.
2015-01-25 15:46:22 -05:00
R David Murray
f1f9675b8a
#23251 : Note that time.sleep affects the calling thread only.
...
This change parallels the language used in the unix man page.
2015-01-25 15:45:14 -05:00
Vinay Sajip
ff37cfe9cc
Issue #23305 : clarified RotatingFileHandler documentation.
2015-01-23 21:19:04 +00:00
Berker Peksag
5a494f6ad8
Issue #22317 : Document the action parameter in ArgumentParser.add_subparsers() docs.
...
Patch by Mike Short.
2015-01-20 06:45:53 +02:00
Serhiy Storchaka
d3faf43f9b
Issue #23181 : More "codepoint" -> "code point".
2015-01-18 11:28:37 +02:00
Ned Deily
ccb416fee2
Issue #23180 : Rename IDLE "Windows" menu item to "Window".
...
Patch by Al Sweigart.
2015-01-17 21:06:27 -08:00
Ethan Furman
8a12329281
Issue22997: minor doc update; thanks to Simoen Visser
2015-01-14 22:31:50 -08:00
Benjamin Peterson
82f34ada45
fix instances of consecutive articles ( closes #23221 )
...
Patch by Karan Goel.
2015-01-13 09:17:24 -05:00
Antoine Pitrou
73dd030c8b
Issue #22952 : improve multiprocessing doc introduction and defer notes until appropriate.
...
Patch by Davin Potts.
2015-01-11 15:05:29 +01:00
Mark Dickinson
dfe0b2326b
Issue #21902 : Replace incorrect 'hyperbolic arc sine' (etc.) with 'inverse hyperbolic sine' (etc.). Remove meaningless reference to radians.
2015-01-11 13:08:05 +00:00
Victor Stinner
7eb10311be
asyncio: SelectSelector is limited to 512 sockets on Windows
2015-01-09 15:59:44 +01:00
Victor Stinner
a092a615f5
asyncio doc: fix section of event loop examples
2015-01-09 15:58:41 +01:00
Victor Stinner
399c59d7bd
asyncio doc: list limitations to run subprocesses from different threads
2015-01-09 01:32:02 +01:00
Berker Peksag
283f1aa881
Issue #20487 : Clarify meaning of "side effect" in the magic mock documentation.
...
Patch by A.M. Kuchling.
2015-01-07 21:15:02 +02:00
Nick Coghlan
b9fdb7a452
Issue 19548: update codecs module documentation
...
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Zachary Ware
5819cfa5aa
Cosmetic fixes to the 'Develop with asyncio' page
2015-01-06 00:40:43 -06:00
Benjamin Peterson
b461000a3f
the current marshal version is 4 ( closes #23167 )
...
Patch by Dmitry Kazakov.
2015-01-04 16:29:48 -06:00
Benjamin Peterson
bab69bf655
update docs for #23111
2014-12-30 15:17:03 -06:00
Benjamin Peterson
5feeebaa84
use a proper m-dash
2014-12-28 22:14:15 -06:00
Berker Peksag
a1a1409e42
Issue #23125 : Update nose project page link.
...
Reported by Damien Marié.
2014-12-28 18:48:33 +02:00
R David Murray
8c4e112afc
#23040 : Clarify treatment of encoding and errors when component is bytes.
...
Patch by Wojtek Ruszczewski.
2014-12-24 21:23:18 -05:00
Victor Stinner
4f9b773a64
asyncio doc: Fix doc of get and put methods of Queue
2014-12-22 22:07:06 +01:00
Barry Warsaw
904c481099
Fix typo.
2014-12-19 11:20:00 -05:00
Raymond Hettinger
558dcf38e6
Issue #23049 : Pure python equivalent shouldn't imply more exactitude than is really there.
2014-12-16 18:16:57 -08:00
Victor Stinner
4d5115c7b5
asyncio doc: call_soon() does not call immediatly the callback. Patch written
...
by Martin Panter.
2014-12-15 17:50:55 +01:00
Raymond Hettinger
d2a296a73a
Issue 23005: Fix typos
2014-12-11 23:56:32 -08:00
Serhiy Storchaka
b252b5ab0c
Issue #22823 : Fixed an output of sets in examples.
2014-12-11 10:30:21 +02:00
Terry Jan Reedy
e40031d1db
whitespace
2014-12-10 18:49:58 -05:00
Terry Jan Reedy
06c6218d00
Issue #23006 whitespace
2014-12-10 18:48:23 -05:00
Terry Jan Reedy
b67f6e27e1
Issue #23006 : Improve the documentation and indexing of dict.__missing__.
...
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
2014-12-10 18:38:19 -05:00
Berker Peksag
8b1cbd2b7c
Issue #12602 : Add missing cross-references to runpy and using/cmdline docs.
...
Patch by Éric Araujo.
2014-12-10 01:47:02 +02:00
Benjamin Peterson
e3b743cd3e
fix reference by adding module name
2014-12-07 17:26:38 -05:00
Benjamin Peterson
a090f01bb6
HTTPSConnection: prefer the context's check_hostname attribute over the constructor parameter ( #22959 )
2014-12-07 13:18:25 -05:00
Benjamin Peterson
b92fd01189
note that sslv3 may not be available
2014-12-06 11:36:32 -05:00
Serhiy Storchaka
b757c83ec6
Issue #22581 : Use more "bytes-like object" throughout the docs and comments.
2014-12-05 22:25:22 +02:00
Terry Jan Reedy
3ab745e386
Edit Menus section of Idle doc. Make menu entries match current Idle in order
...
and case. Edit some of the explanatory sentences and end all with a period.
2014-12-05 02:43:07 -05:00
Yury Selivanov
a5ef83244b
docs.inspect: Fix BoundArguments example. Issue #22998 .
2014-12-04 22:47:44 -05:00
Terry Jan Reedy
bb37b4ca73
Issue #3068 : Document the new Configure Extensions dialog and menu entry.
2014-12-04 01:26:04 -05:00
Terry Jan Reedy
f56849486b
Issue #16893 : For Idle doc, move index entries, copy no-subprocess section
...
from idlelib/help.txt, add 'C' comment, and remove obsolete ^Z comment
Original patch by Zach Ware.
2014-12-04 00:54:59 -05:00
Antoine Pitrou
2b207badd6
Fix #22987 : update the compatibility matrix for a SSLv23 client.
2014-12-03 20:00:56 +01:00
Serhiy Storchaka
1ad088f3ea
Issue #14099 : ZipFile.open() no longer reopen the underlying file. Objects
...
returned by ZipFile.open() can now operate independently of the ZipFile even
if the ZipFile was created by passing in a file-like object as the first
argument to the constructor.
2014-12-03 09:11:57 +02:00
Victor Stinner
d87de83582
Closes #22475 : asyncio doc, fix Task.get_stack() doc
2014-12-02 17:57:04 +01:00
Victor Stinner
039f703b7b
Close #22473 : asyncio doc: rephrase Future with run_forever() example
2014-12-02 17:52:45 +01:00
Serhiy Storchaka
56a6d855e2
Removed duplicated words in in comments and docs.
2014-12-01 18:28:43 +02:00
Benjamin Peterson
b7138e24e3
context is keyword-only
2014-11-29 23:38:17 -05:00
Benjamin Peterson
c1da3d1ed8
add context parameter to xmlrpclib.ServerProxy ( #22960 )
...
Patch by Alex Gaynor.
2014-11-29 23:32:57 -05:00
Victor Stinner
e7182979d6
Closes #22348 : Rephrase asyncio.StreamWriter.drain() documentation
...
Patch written by Martin Richard.
2014-11-28 17:45:41 +01:00
Victor Stinner
1deee54e0c
asyncio doc: reformat event loop policy doc
2014-11-28 13:58:28 +01:00
Victor Stinner
8464c24c82
asyncio doc: explain how to pass keywords to callbacks (functools.partial)
2014-11-28 13:15:41 +01:00
Serhiy Storchaka
7a6915e17d
Issue #21514 : The documentation of the json module now refers to new JSON RFC
...
7159 instead of obsoleted RFC 4627.
2014-11-27 19:41:47 +02:00
Zachary Ware
4847035458
pydoc: Add a note about setting PAGER to affect console output pagination.
...
Suggested by James Lowden on docs@.
2014-11-26 23:44:25 -06:00
Ethan Furman
b004943e9b
(3.4) Issue22780: reword NotImplemented docs to emphasise should
2014-11-26 21:15:35 -08:00
Zachary Ware
61aebca09d
pydoc: Remove mention of '-g' command line option, document its removal.
2014-11-26 22:57:35 -06:00
Berker Peksag
c8c64e30e8
Issue #20351 : Add examples for csv.DictReader and csv.DictWriter.
...
Patch by Charles-Axel Dein.
2014-11-24 23:46:30 +02:00
Benjamin Peterson
43052a14c1
add context parameter to HTTPHandler ( closes #22788 )
2014-11-23 20:36:44 -06:00
Benjamin Peterson
dbd4bcfcca
correct versionchanged version
2014-11-23 20:09:31 -06:00
Benjamin Peterson
7243b574e5
don't require OpenSSL SNI to pass hostname to ssl functions ( #22921 )
...
Patch by Donald Stufft.
2014-11-23 17:04:34 -06:00
Benjamin Peterson
378e15d7ab
document that cadefault does nothing now
2014-11-23 11:43:33 -06:00
Serhiy Storchaka
f751a9e6a2
Issue #22845 : Improved formatting of dis documentation.
2014-11-11 10:02:11 +02:00
Berker Peksag
4900877bca
Issue #22839 : Fix Snapshot.statistics() link.
2014-11-10 23:15:32 +02:00
Raymond Hettinger
86e9b6b164
Issue 22830: Clarify docs for functools.cmp_to_key().
2014-11-09 17:20:56 -08:00
Berker Peksag
b556399fb5
Issue #22808 : Link to the correct time method in BaseEventLoop.call_at().
...
Patch by Mark Grandi.
2014-11-07 19:51:07 +02:00
Raymond Hettinger
dc69e03ef3
Issue 22803: Add missing versionadded directive.
2014-11-05 21:27:56 -08:00
Georg Brandl
b9b389efed
Closes #22525 : clarify documentation for ast.literal_eval().
2014-11-05 20:20:28 +01:00
Benjamin Peterson
4ffb075271
PEP 476: enable HTTPS certificate verification by default ( #22417 )
...
Patch by Alex Gaynor with some modifications by me.
2014-11-03 14:29:33 -05:00
Benjamin Peterson
a5c9c37dd5
wrap
2014-11-02 13:17:56 -05:00
Senthil Kumaran
8b7e161ac3
backport context argument of urlopen ( #22366 ) for pep 476
2014-09-19 15:23:30 +08:00
R David Murray
64f10d4f5e
Reflow paragraph.
2014-11-02 12:32:26 -05:00
R David Murray
3ca68e77b8
Fix English phrasing.
2014-11-02 12:31:47 -05:00
Georg Brandl
36ac510956
Closes #22771 : "verbose" is unused; deprecate it.
2014-10-31 10:54:06 +01:00
Georg Brandl
8ed75cd8e9
#22613 : minor other fixes in library docs (thanks Jacques Ducasse)
2014-10-31 10:25:48 +01:00
Georg Brandl
2677faecf5
#22613 : document Cmd.cmdqueue (thanks Jacques Ducasse)
2014-10-31 10:25:38 +01:00
Georg Brandl
717e02896f
#22613 : fix heading levels in tracemalloc docs (thanks Jacques Ducasse)
2014-10-31 10:21:07 +01:00
Georg Brandl
9b1b0e54e7
#22613 : elaborate on arguments of shutil archival functions (thanks Jacques Ducasse)
2014-10-31 10:02:40 +01:00
Georg Brandl
f30132fdc9
#22613 : explain what "buffer" is in the struct documentation (thanks Jacques Ducasse)
2014-10-31 09:46:41 +01:00
Georg Brandl
e4196d3f2e
#22613 : fix several factual errors in builtin docs (thanks Jacques Ducasse)
2014-10-31 09:41:46 +01:00
Georg Brandl
4433ff958b
unittest.mock docs: fix use of default role
2014-10-31 07:59:37 +01:00
Georg Brandl
ef08bde8b8
minor markup fix: no inline markup is allowed in a module synopsis
2014-10-30 22:45:27 +01:00
Georg Brandl
6b4c847c4f
Doc: fix default role usage (except in unittest mock docs)
2014-10-30 22:26:26 +01:00
Georg Brandl
b7354a65ce
Fixing broken links in doc, part 4: some more breaks and redirects
2014-10-29 10:57:37 +01:00
Georg Brandl
525d355984
Fixing broken links in doc, part 3: the rest
2014-10-29 10:26:56 +01:00
Georg Brandl
728e4debd8
Fix external links to docs.python.org to use internal links instead.
2014-10-29 09:00:30 +01:00
Georg Brandl
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
Georg Brandl
ce64cedff4
Fix module name.
2014-10-28 22:58:24 +01:00
Georg Brandl
946faa39e3
Using "-m module" is easier to read and understand than "-mmodule".
2014-10-28 22:54:24 +01:00
Georg Brandl
2b07b0e868
Closes #22249 : use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param
2014-10-28 22:45:27 +01:00
Georg Brandl
c943e79384
Remove duplicate bullet point.
2014-10-28 22:40:48 +01:00
Georg Brandl
bb2d669292
Closes #22736 : move seealso to the bottom of the section about RE syntax.
2014-10-28 21:41:51 +01:00
Georg Brandl
01546a88b8
Closes #22749 : remove outdated advice to use clock() for accurate timing.
2014-10-28 21:35:35 +01:00
Ezio Melotti
788f2adeae
#22196 : link to Enum in the nametuple documentation. Patch by Karmen Dykstra.
2014-10-28 15:07:14 +01:00
Ezio Melotti
9b1e92f5a1
#22237 : document that sorted() is guaranteed to be stable. Initial patch by Martin Panter.
2014-10-28 12:57:11 +01:00
Nick Coghlan
3894ae20ea
Issue #22711 : improve links in new distribution docs
...
- key term hyperlinks for distutils, setuptools & wheel
- distutils landing page links directly to setuptools docs
- short summary of setuptools benefits provided with link
2014-10-26 00:00:04 +10:00
Victor Stinner
2cef300187
asyncio doc: fix typo in an example
2014-10-23 22:38:46 +02:00
Victor Stinner
c803bd84b5
Issue #22695 : Fix syntax of open() doc
2014-10-22 09:55:44 +02:00
Antoine Pitrou
4b4ddb2190
Issue #22660 : update various mentions in the ssl module documentation.
2014-10-21 00:14:39 +02:00
Jesus Cea
67503c5f1c
Docs: 'os.pwrite()' needs bytes, not strings
2014-10-20 16:18:24 +02:00
Benjamin Peterson
0fc08fd2c7
merge 3.3
2014-10-19 10:47:58 -04:00
Benjamin Peterson
9fc59c9fc2
make plural s lowercase
2014-10-19 10:47:49 -04:00
Victor Stinner
7f314ed71b
asyncio doc: write simpler examples to introduce asyncio
2014-10-15 18:49:16 +02:00
Ethan Furman
7184bac544
Issue20386: SocketType is again socket.socket; the IntEnum SOCK constants are SocketKind
2014-10-14 18:56:53 -07:00
Victor Stinner
39892055cd
asyncio doc: rewrite subprocess doc
...
* add a new example using transport and protocol
* rewrite the example using streams to make it much simpler (remove error
handling, use a simpler Python code)
* copy (and adapt) more documentation from the subprocess module:
- add a note about Process.wait() deadlock
- add a note about shell injection
- etc.
* sort Process methods and attributes in the same order than subprocess.Popen
methods and attributes, so the documentation looks closer
* list differences between Process and subprocess.Popen APIs
2014-10-14 00:52:07 +02:00
Victor Stinner
3c95062f52
asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must
...
instanciate a subclass of SubprocessProtocol
2014-10-14 00:02:10 +02:00
Victor Stinner
4270a24dd9
asyncio doc: document BaseSubprocessTransport.close() method
...
Modify also the get_pipe_transport() doc to mention explicitly the supported
file descriptors.
2014-10-13 23:56:43 +02:00
Benjamin Peterson
157da6fdd2
merge 3.3
2014-10-13 11:55:02 -04:00
Benjamin Peterson
77a75b3db1
note xmlrpclib doesn't verify certs (yet)
2014-10-13 11:54:50 -04:00
Victor Stinner
ed8e3a987e
asyncio: add missing @coroutine decorator
2014-10-13 00:55:50 +02:00
Victor Stinner
ab1c853079
asyncio doc: update debug traces
2014-10-12 21:37:16 +02:00
Victor Stinner
980dd84f92
asyncio doc: more explicit doc for async()
...
The function schedules the execution of coroutines, it's not just a wrapper for
something.
2014-10-12 21:36:17 +02:00
Victor Stinner
33f6abe4ae
asyncio doc: reformat create_server() doc
...
Fix also the reate_unix_connection() doc: the method is not support on Windows,
not need to mention that ssl is not support with ProactorEventLoop.
2014-10-12 20:36:04 +02:00
Victor Stinner
ed051594d7
asyncio doc: add TCP echo client/server using streams
2014-10-12 20:18:16 +02:00
Georg Brandl
62b08136d7
Closes #22586 : clarify meaning of allow_fragments in urlparse.
2014-10-12 16:13:32 +02:00
Victor Stinner
5366434336
asyncio doc: enhance TCP client example
2014-10-12 11:35:09 +02:00
Victor Stinner
cfbea3a02e
asyncio doc: clarify how servers create protocol instances
2014-10-12 11:30:17 +02:00
Victor Stinner
c7edffdddd
asyncio doc: add UDP client and server examples
2014-10-12 11:24:26 +02:00
Victor Stinner
c2721b41d3
asyncio doc: use server.wait_closed() in TCP echo server example
2014-10-12 11:13:40 +02:00
Berker Peksag
edd6ec2dd3
Issue #22613 : Fix reprlib.Repr subclass example on Python 3.
...
Reported by Jacques Ducasse.
2014-10-12 05:11:16 +03:00
Nick Coghlan
36d8ef9cc7
Issue #21061 : correctly note redirect_stdout is reentrant
2014-10-12 10:25:00 +10:00
Victor Stinner
ccd8e34508
asyncio doc: socket.socketpair() is not available on Windows yet
2014-10-11 16:30:02 +02:00
Victor Stinner
04e6df330d
asyncio doc: add examples showing the 3 ways to wait for data from an open
...
socket
2014-10-11 16:16:27 +02:00
Victor Stinner
6888b96cee
asyncio doc: cleanup Hello World examples
2014-10-11 16:15:58 +02:00
Victor Stinner
5121a9ba4a
asyncio doc: the "Get HTTP headers" example now supports HTTPS
2014-10-11 15:52:14 +02:00
Georg Brandl
dbf8344404
Closes #18959 : move optparse and imp to new "superseded modules" chapter
2014-10-11 14:47:11 +02:00
Georg Brandl
c5dd095a9b
Closes #21675 : fix ordering of description in library intro
2014-10-11 14:32:34 +02:00