Commit Graph

6312 Commits

Author SHA1 Message Date
Martin Panter d8302624c9 Issue #24984: BTPROTO_SCO supports only bytes objects 2015-09-11 02:23:41 +00:00
Berker Peksag 920f6db10b Use print function in mock docs. 2015-09-10 21:41:15 +03:00
Martin Panter d1a98587fe Issue #24984: Document AF_BLUETOOTH socket address formats
Patch from Tim Tisdall.
2015-09-09 06:47:58 +00:00
Martin Panter 9499413508 os.sendfile(headers=None, trailers=None) arguments are not actually accepted
Needs to be tested on a BSD.
2015-09-09 05:29:24 +00:00
Martin Panter bf19d16950 Issue #23738: Document and test actual keyword parameter names
Also fix signature because os.utime(..., ns=None) is not allowed.
2015-09-09 01:01:13 +00:00
Martin Panter 7f02d6d0d9 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 02:08:55 +00:00
R David Murray 17227a7334 #24998: fix cut and paste error in subprocess example. 2015-09-04 10:01:19 -04:00
Victor Stinner 5492d358e4 asyncio doc: fix subprocess sections 2015-09-02 15:39:01 +02:00
Martin Panter 31e7f50d4c Issue #24952: Clarify default argument of stack_size() in threading, _thread
Patch from Mattip.
2015-08-31 03:15:52 +00:00
Benjamin Peterson 0612ffe8c8 fix spelling that was a bit confused (closes #24963) 2015-08-30 14:42:38 -07:00
Raymond Hettinger 7a3602e7cf Issue #24931: Resolve __dict__ conflict in namedtuple subclasses. 2015-08-30 09:13:48 -07:00
Zachary Ware 5e580da0b6 Issue #24947: Fix grammar in asyncio doc
Patch by tagatac
2015-08-27 15:54:39 -05:00
R David Murray 87cbfb20fb #24926: Fix typo in example. 2015-08-24 12:55:03 -04:00
Robert Collins a2b0055396 Issue #22812: Fix unittest discovery examples.
Patch from Pam McA'Nulty.
2015-08-24 12:14:28 +12:00
Ned Deily eca0445733 Issue #24079: Improve description of the text and tail attributes for
ElementTree Element objects.  Initial patch by Martin Panter.
2015-08-17 22:11:17 -04:00
Antoine Pitrou 4ce4f974da Issue #16554: fix description for MAKE_CLOSURE. Initial patch by Daniel Urban. 2015-08-13 20:37:08 +02:00
Zachary Ware 79b98df023 Issue #21279: Flesh out str.translate docs
Initial patch by Kinga Farkas, Martin Panter, and John Posner.
2015-08-05 23:54:15 -05:00
Robert Collins 1ae28d2ff3 Issue #20769: Improve reload() docs. Patch by Dorian Pula. 2015-08-05 08:20:53 +12:00
Terry Jan Reedy 30f1f67248 Issue #13884: Idle: Remove tearoff lines from menus. Patch by Roger Serwy. 2015-07-30 16:44:22 -04:00
Berker Peksag 41ca828580 Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().

Patch by Nick Weinhold.
2015-07-30 18:26:10 +03:00
Robert Collins 1ee9283254 Issue #23254: Document how to close the TCPServer listening socket.
Patch from Martin Panter.
2015-07-29 12:52:40 +12:00
Robert Collins f79dfe3f25 Add versionchanged information for mock_open. 2015-07-24 04:09:59 +12:00
Robert Collins ca647ef60a Issue #21750: Further fixup to be styled like other mock APIs. 2015-07-24 03:48:20 +12:00
Robert Collins e02f6c20ff Issue #22153: Improve unittest docs. Patch from Martin Panter and evilzero. 2015-07-23 06:37:26 +12:00
Zachary Ware e36402a830 Fix usage of the default role.
The changes to Doc/library/unittest.mock.rst are almost entirely a
selective backport of the 3.5 page.
2015-07-06 23:58:12 -05:00
Zachary Ware 5c676f67d1 Fix suspicious markup 2015-07-06 23:27:15 -05:00
Benjamin Peterson 7dcbf900ac 'not' is very important here 2015-07-06 11:28:07 -05:00
Benjamin Peterson b8fd26256e tighten warning 2015-07-06 09:40:43 -05:00
Ned Deily f1ce6deb41 Issue #24330: Update IDLE doc and help to note "Configure IDLE" difference
on OS X.  Original patch by André Freitas.
2015-07-04 15:05:07 -07:00
R David Murray a1005ed1aa #24584: replace dead link with pointer to archive.org. 2015-07-04 15:44:14 -04:00
Berker Peksag 89584c97e4 Issue #23684: Clarify the return value of the scheme attribute of ParseResult and SplitResult objects.
Patch by Martin Panter.
2015-06-25 23:38:48 +03:00
Yury Selivanov 1096f761b6 Issue #24509: Clarify Handle.cancel() and loop.call_* methods. 2015-06-25 13:49:52 -04:00
Yury Selivanov bb96134368 asyncio.docs: Use less confusing title 2015-06-25 11:54:34 -04:00
Senthil Kumaran b4760efbad Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
Related Issues:

#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
Raymond Hettinger 1c90670bc2 Issue #24453: Fix doubled word. 2015-06-14 16:08:06 -07:00
Terry Jan Reedy 6ac5cc15ce whitespace 2015-06-12 16:47:44 -04:00
Terry Jan Reedy fe63c9a298 Issue #24406: Add sentences on dict comparisons, similar to those for Sequence
and set comparisions.  Patch by Gareth Rees.
2015-06-12 16:38:57 -04:00
Barry Warsaw 17d5f47423 - Issue #24351: Clarify what is meant by "identifier" in the context of
string.Template instances.
2015-06-09 14:20:31 -04:00
Benjamin Peterson d9ede872cd that this is "for Python" is obvious 2015-06-05 21:03:08 -05:00
Berker Peksag 12b50ce4cb Issue #23659: Document **fmtparams in csv.register_dialect docstring.
Initial patch by Brandon Milam.
2015-06-05 15:17:51 +03:00
Berker Peksag 25587742f6 Issue #24148: Fix incorrect Stats.sort_stats() example.
"cum" is not a valid argument.

Patch by Brandon Milam.
2015-06-05 14:48:29 +03:00
Ned Deily 11cf4f6498 Issue #24357: use example.org instead 2015-06-01 21:19:30 -07:00
Ned Deily 834f029c74 Issue #24357: fix real typo 2015-06-01 19:37:40 -07:00
Ned Deily 9e2dc3f0b1 Issue #24357: fix typo 2015-06-01 19:17:44 -07:00
Ned Deily 1b79e2d7ee Issue #24357: Change host in socket.getaddrinfo example to one that
does support IPv6 and IPv4; www.python.org currently does not.
2015-06-01 18:52:48 -07:00
Yury Selivanov 0339568753 Issue 22357: Document __qualname__ in inspect.rst 2015-05-30 13:53:49 -04:00
Terry Jan Reedy 43cba219d5 Make expression legal python by adding '1'. 2015-05-23 16:16:28 -04:00
Berker Peksag 315e104d11 Issue #24232: Fix typos. Patch by Ville Skyttä. 2015-05-19 01:36:55 +03:00
Berker Peksag 2a8baed833 Issue #24233: Add a proper link to socket.getfqdn() documentation.
Patch by Ville Skyttä.
2015-05-19 01:31:00 +03:00
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
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
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
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
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
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
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
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
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