Commit Graph

8640 Commits

Author SHA1 Message Date
csabella 56ddfd2eea bpo-27618: Clarify that threading.Lock is a factory function (GH-1307) 2017-05-31 17:14:19 -07:00
Albert-Jan Nijburg fc354f0785 bpo-25324: copy tok_name before changing it (#1608)
* add test to check if were modifying token

* copy list so import tokenize doesnt have side effects on token

* shorten line

* add tokenize tokens to token.h to get them to show up in token

* move ERRORTOKEN back to its previous location, and fix nitpick

* copy comments from token.h automatically

* fix whitespace and make more pythonic

* change to fix comments from @haypo

* update token.rst and Misc/NEWS

* change wording

* some more wording changes
2017-05-31 16:00:21 +02:00
Gregory P. Smith 163468a766 bpo-16500: Don't use string constants for os.register_at_fork() behavior (#1834)
Instead use keyword only arguments to os.register_at_fork for each of the scenarios.
Updates the documentation for clarity.
2017-05-29 10:03:41 -07:00
Antoine Pitrou 346cbd351e bpo-16500: Allow registering at-fork handlers (#1715)
* bpo-16500: Allow registering at-fork handlers

* Address Serhiy's comments

* Add doc for new C API

* Add doc for new Python-facing function

* Add NEWS entry + doc nit
2017-05-27 17:50:54 +02:00
Mariatta f931fd1c2a bpo-30470: Deprecate invalid ctypes call protection on Windows. (GH-1810)
Calling Ctypes functions is deprecated in 3.6.2 and will be removed in 3.7
2017-05-27 07:23:26 -07:00
Serhiy Storchaka 12d6b5d156 bpo-30398: Add a docstring for re.error. (#1647)
Also document that some attributes may be None.
2017-05-27 16:12:48 +03:00
Serhiy Storchaka 5becf38a03 Fix the signature of JSONDecodeError (no end parameter). (#1827)
Unlikely to the simplejson module, json.JSONDecodeError doesn't accept the end argument.
2017-05-27 16:11:18 +03:00
Sanyam Khurana 08e2f355d0 bpo-22702: Clarify documentation of str.join & bytes.join (GH-156)
The "iterable iterable" phrasing created confusion between the term
reference and the parameter name.

This simplifies the phrasing to just use the parameter name
without linking directly to the term definition.
2017-05-27 15:44:41 +10:00
Alex Gaynor 368cf1d206 bpo-30420: List cwd parameter in subprocess convenience APIs (GH-1685)
Partially clarify the subprocess convenience API documentation by
explicitly listing the `cwd` parameter in their abbreviated signatures.

While this has been merged as an improvement, it doesn't fully
resolve the issue, as the `cwd` should also be covered in the
"Frequently Used Arguments" section, and the fact these APIs
pass unlisted keyword arguments down to the lower level APIs
is currently still unclear.
2017-05-26 12:28:17 +10:00
Garvit Khatri 94987826e8 bpo-29851: Have importlib.reload() raise ImportError if the module's spec is not found (GH-972) 2017-05-24 15:19:50 -07:00
jugglinmike a083c8ee6c bpo-30160: Clarify intended usage of wfile (gh-1300)
The library does not enforce compliance with the HTTP protocol,
so violations are not technically disallowed. Extend the stream's
description to avoid suggesting that intentional protocol violations are
not supported.
2017-05-24 14:25:50 -04:00
Stéphane Wirtel a17a2f52c4 bpo-28707: Add the directory parameter to http.server.SimpleHTTPRequestHandler and http.server module (#1776)
* bpo-28707: call the constructor of SimpleHTTPRequestHandler in the test with a mock object

* bpo-28707: Add the directory parameter to http.server.SimpleHTTPRequestHandler and http.server module
2017-05-24 00:29:06 -07:00
Brian Ward c9d6dbc290 Added effect of re.ASCII and reworded slightly (#1782) 2017-05-24 00:03:38 -07:00
Amit Kumar d618c8c6d3 bpo-21056: Document return type of next method of csv reader (#146) 2017-05-22 22:09:42 -07:00
Berker Peksag 93fc20b73e bpo-30376: Update outdated WindowObject references (#1630) 2017-05-22 17:16:07 -07:00
Ben Lloyd 15033d145b Corrected grammar mistake in documentation (#1713)
There was an unneeded space before a closing parenthesis in the `unittest.mock` documentation.
2017-05-22 14:06:56 +03:00
delirious-lettuce 3378b2062c Fix typos in multiple `.rst` files (#1668) 2017-05-19 23:37:57 +03:00
delirious-lettuce c7b3f0fc3b Remove trailing semicolon in datetime doc example (GH-1653) 2017-05-18 18:01:00 -07:00
Serhiy Storchaka d97b7dc94b bpo-30380: Fix Sphinx 1.6.1 warnings. (#1613)
* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS.
2017-05-16 23:18:09 +03:00
Howie Benefiel f6e863d868 bpo-29651 - Cover edge case of square brackets in urllib docs (#1128) 2017-05-15 21:48:16 -07:00
Serhiy Storchaka edef358ed6 bpo-29196: Removed old-deprecated classes Plist, Dict and _InternalDict (#488)
in the plistlib module.  Dict values in the result of functions
readPlist() and readPlistFromBytes() are now exact dicts.
2017-05-15 13:21:31 +03:00
Victor Stinner 89a1c93f04 bpo-9850: Deprecate the macpath module (#1540)
Co-Authored-By: Chi Hsuan Yen <yan12125@gmail.com>.
2017-05-15 11:01:21 +02:00
csabella 9977629623 bpo-30358: Document sort argument of profile.runctx() (GH-1566) 2017-05-14 10:02:38 +03:00
Jim Fasarakis-Hilliard c71168090d bpo-30178: Indent methods and attributes of MimeType class (GH-1306) 2017-05-13 09:34:27 -07:00
Vinay Sajip 82a6384733 Indented Handler sections for improved clarity. (#1554)
Indented parts of the Handler class documentation for improved presentation, analogous to a recent similar change for the Logger class.
2017-05-12 09:38:13 +01:00
Pierre Quentel cc3fa204d3 bpo-29979: Rewrite cgi.parse_multipart to make it consistent with FieldStorage (#991) 2017-05-08 05:08:34 -07:00
Jim Fasarakis-Hilliard 55ace65eba Closes bpo-30168: indent methods in Logger Class (#1295) 2017-05-07 19:40:18 +01:00
Jelle Zijlstra a12df7b7d4 bpo-30218: support path-like objects in shutil.unpack_archive() (GH-1367)
Thanks to Jelle Zijlstra for the patch.
2017-05-05 14:27:12 -07:00
masklinn c07b3a15be bpo-29920: Document cgitb.text() and cgitb.html() functions (GH-849) 2017-05-05 11:15:12 +03:00
Serhiy Storchaka 898ff03e1e bpo-30215: Make re.compile() locale agnostic. (#1361)
Compiled regular expression objects with the re.LOCALE flag no longer
depend on the locale at compile time.  Only the locale at matching
time affects the result of matching.
2017-05-05 08:53:40 +03:00
Victor Stinner b109a1d336 bpo-30273: Update sysconfig (#1464)
The AST_H_DIR variable was removed from Makefile.pre.in by the commit
a5c62a8e9f (bpo-23404).

AST_H_DIR was hardcoded to "Include", so replace the removed variable
by its content.

Remove also ASDLGEN variable from sysconfig example since this
variable was also removed.
2017-05-04 23:29:09 +02:00
Serhiy Storchaka dbaf746b6d bpo-29956: Improve the math.exp() related documentation. (#1073) 2017-05-04 12:25:09 +03:00
UltimateCoder 8856940cf2 bpo-28315: Improve code examples in docs (GH-1372)
Replace
   File "<stdin>", line 1, in ? 
with 
   File "<stdin>", line 1, in <module>
2017-05-03 09:46:45 -07:00
Xiang Zhang 13f1f423fa bpo-30103: Allow Uuencode in Python using backtick as zero instead of space (#1326) 2017-05-03 11:16:21 +08:00
Tong SHEN b0d8203654 Fix typo in selectors.rst (#1383)
decriptor -> descriptor
2017-05-02 06:27:57 -07:00
Nathaniel J. Smith d4069de511 Clean up some confusing text left by PROTOCOL_SSLv23 -> PROTOCOL_TLS transition (#1355) 2017-05-01 22:43:31 -07:00
Jelle Zijlstra 2e624690bd bpo-29679: Implement @contextlib.asynccontextmanager (#360) 2017-04-30 18:25:58 -07:00
csabella 9dc2b3809f bpo-30208: DOC: fix small typos in IDLE (#1354) 2017-04-29 18:28:36 -04:00
Marco Buttu e65fcde85a bpo-27200: Fix several doctests (GH-604) 2017-04-27 15:23:34 +03:00
Dong-hee Na a90b990480 bpo-30142: Remove "callable" from the 2to3fixer documentation. (GH-1296) 2017-04-26 09:16:21 -07:00
Eijebong ab7886b785 bpo-30101: Add support for curses.A_ITALIC. (#1015) 2017-04-26 23:17:12 +08:00
Mathias Rav 87c07fe9d9 bpo-29974: Improve typing.TYPE_CHECKING example (GH-982)
* Fix PEP 8 (SomeType instead of some_type)
* Add a function parameter annotation
* Explain, using wording from PEP 484 and PEP 526,
  why one annotation is in quotes and another is not.

Suggested by Ivan Levkevskyi.
2017-04-26 13:49:45 +03:00
Louie Lu 0d637e236d bpo-28698: Fix c_wchar_p doc example (GH-1160) 2017-04-26 11:15:05 +03:00
csabella c6db4811f9 bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271)
Builtin container types have two potential link targets in the docs:

- their entry in the list of builtin callables
- their type documentation

This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry.
2017-04-26 15:47:01 +10:00
Jim Fasarakis-Hilliard 08c16016e2 bpo:29950: Rename SlotWrapperType to WrapperDescriptorType (GH-926) 2017-04-25 21:26:36 +03:00
csabella 97bf722fcd bpo-28851: Improve namedtuple documentation (GH-1274)
Clarify that a sequence of strings is the preferred value for 'field_names'.
2017-04-25 09:14:45 -07:00
Serhiy Storchaka 2e576f5aec bpo-30144: Import collections ABC from collections.abc rather than collections. (#1263) 2017-04-24 09:05:00 +03:00
Louie Lu 7fae81e167 Fix trailing colon and newline in test.rst (#1250) 2017-04-22 09:46:18 +03:00
Berker Peksag 6dbdedb0b1 bpo-10379: Add %char examples to locale.format() docs (GH-1145) 2017-04-20 07:38:43 +03:00
Serhiy Storchaka fdbd01151d bpo-10076: Compiled regular expression and match objects now are copyable. (#1000) 2017-04-16 10:16:03 +03:00
Serhiy Storchaka 5908300e4b bpo-29995: re.escape() now escapes only special characters. (#1007) 2017-04-13 21:06:43 +03:00
Joshua Diaddigo 873ef20d00 Fix a typo in Doc/library/functions.rst (GH-1117)
Replace `For object's ... ` with `For objects ...`
2017-04-13 10:31:37 -07:00
Serhiy Storchaka 8fc7bc2b76 bpo-30021: Add examples for re.escape(). (#1048)
And fix the parameter name.
2017-04-13 19:17:36 +03:00
Marco Buttu 7b2491a6aa bpo-27200: Fix pathlib, ssl, turtle and weakref doctests (GH-616) 2017-04-13 17:17:59 +03:00
Berker Peksag 61b9ac9371 bpo-29791: Clarify that flush is keyword-only argument (#1093)
Reported by Lucio Ricardo Montero Valenzuela.
2017-04-13 15:48:18 +03:00
Marco Buttu 2c0b5c664b bpo-30055: add testcleanup to leave a fresh context (#1094) 2017-04-13 13:30:25 +02:00
Xiang Zhang a6902e662c bpo-26985: Add missing info of code object in inspect documentation (GH-1090) 2017-04-13 10:38:28 +08:00
NAKAMURA Osamu 3e0f1fc4e0 bpo-30047: Fix a typo in Doc/library/select.rst (#1086) 2017-04-12 13:30:40 +03:00
Sanyam Khurana 19e0494256 bpo-29506: Clarify deep copy note in copy module
The reference to administrative data was confusing to readers,
so this simplifies the note to explain that deep copying may copy
more then you intended, such as data that you expected to be
shared between copies.
2017-04-09 20:22:30 +10:00
Jelle Zijlstra 45d22c256b Improvements to typing documentation (#967)
Documents a few omitted classes and adds NamedTuple methods.
2017-04-08 19:09:14 +03:00
Barry Warsaw dd9a0a14c8 Fix a minor typo. (#1032) 2017-04-07 14:18:14 -04:00
Alex Jordan 01fa9ae546 Correct typo in configparser.rst (#1012) 2017-04-05 22:21:30 -04:00
Mark Dickinson a0ce375e10 bpo-29962: add math.remainder (#950)
* Implement math.remainder.

* Fix markup for arguments; use double spaces after period.

* Mark up function reference in what's new entry.

* Add comment explaining the calculation in the final branch.

* Fix out-of-order entry in whatsnew.

* Add comment explaining why it's good enough to compare m with c, in spite of possible rounding error.
2017-04-05 18:34:27 +01:00
csabella 02e1213800 bpo-29725: DOC: add text for arraysize in sqlite3.Cursor (#947)
* bpo-29725: DOC: add text for arraysize in sqlite3.Cursor
2017-04-03 22:16:14 -07:00
Mark Dickinson 734125938d Fix misleading documentation for math.exp. (#951) 2017-04-02 08:30:04 -07:00
Pierre Quentel 351adda54b bpo-29654 : Support If-Modified-Since HTTP header (browser cache) (#298)
Return 304 response if file was not modified.
2017-04-02 13:26:12 +03:00
s-sanjay 16f852345b bpo-29913: deprecate compare_networks() in documentation (GH-865) 2017-03-30 15:44:29 +08:00
Serhiy Storchaka ea720fe7e9 bpo-25996: Added support of file descriptors in os.scandir() on Unix. (#502)
os.fwalk() is sped up by 2 times by using os.scandir().
2017-03-30 09:12:31 +03:00
csabella 85deefcf61 bpo-29677: DOC: clarify documentation for `round` (GH-877) 2017-03-29 14:14:06 -07:00
Garvit Khatri 1cf93a76c2 bpo-10379: add 'monetary' to format_string, deprecate format
Add the 'monetary' parameter to format_string so that all
uses of format can be converted to format_string.  Adjust
the documentation accordingly, and add a deprecation
warning when format is used.
2017-03-28 11:43:38 -04:00
Barry Warsaw 9f74deba78 Improve the documentation for template strings (#856)
bpo-19824
bpo-20314
bpo-12518
2017-03-28 10:02:07 -04:00
Gerrit Holl 6003db7db5 bpo-29677: DOC: clarify documentation for `round` (#357)
* DOC: clarify documentation for `round`

Clarified that `round` can take a negative value for *ndigits*.

* DOC: remove trailing whitespace in previous commit

remove trailing whitespace in previous commit
2017-03-28 00:15:20 +02:00
Serhiy Storchaka 4aec9a8be2 bpo-29901: Improve support of path-like objects in zipapp. (#815)
Now general path-like objects are supported, not just pathlib.Path.
2017-03-25 13:05:23 +02:00
NAKAMURA Osamu 29540cdf6c bpo-29892: Fix wrong markup on doc-lib-functions (GH-802) 2017-03-24 19:55:08 -07:00
Ivan Levkivskyi 8f9e1bbf2d bpo-28810: Document remaining bytecode changes in 3.6 (GH-651) 2017-03-24 14:05:04 -07:00
Serhiy Storchaka e304e33c16 bpo-19930: The mode argument of os.makedirs() no longer affects the file (#799)
permission bits of newly-created intermediate-level directories.
2017-03-24 13:27:42 +02:00
Sylvain Bellemare 5619ab2db3 doc: Fix small typos in library/multiprocessing (GH-698) 2017-03-24 17:26:07 +09:00
Nathaniel J. Smith 1e2147b9d7 bpo-29728: Provide socket.TCP_NOTSENT_LOWAT (#477)
* Provide socket.TCP_NOTSENT_LOWAT
* New TCP option available on recent MacOS and Linux.
* Document addition of TCP_NOTSENT_LOWAT
2017-03-22 20:56:55 -07:00
INADA Naoki bd3d8ba3b2 doc: minor fix for library/profile (GH-761) 2017-03-22 16:56:36 +09:00
Jelle Zijlstra 75b6cf879f fix function name in tabnanny documentation (GH-759) 2017-03-22 14:53:57 +08:00
zertrin 05f53735c8 Fix "NotImplentedError" typo in constants documentation (#692)
`NotImplentedError` --> `NotImplementedError`
2017-03-20 14:24:39 +02:00
Mariatta 64508780d7 bpo-29856: Fix typo in curses documentation (GH-730)
From Shifted Dxit -> Shifted Exit in Doc/library/curses.rst
2017-03-19 20:48:04 -07:00
Marco Buttu 909a6f626f bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
Marco Buttu 3f2155ffe6 bpo-16355: Clarify when inspect.getcomments() returns None (#428)
Initial patch by Vajrasky Kok.
2017-03-17 11:50:23 +03:00
Marco Buttu 1bb0f3762e bpo-29820: othergui.rst: Remove outdated information (GH-685) 2017-03-16 19:50:40 -07:00
Jelle Zijlstra 9e52c907b5 ftplib.FTP.retrbinary callback gets a bytes, not a str (GH-652) 2017-03-13 10:51:27 +08:00
Jelle Zijlstra 7bb6ac76b2 fix the name of argument to ftplib.FTP.set_pasv and fix wording (GH-653) 2017-03-13 10:19:00 +08:00
Xiang Zhang b2d77175d1 bpo-29756: Improve documentation for list methods that compare items by equality (GH-572) 2017-03-13 10:09:16 +08:00
Serhiy Storchaka c611a5b1d4 bpo-29746: Update marshal docs to Python 3. (#547) 2017-03-12 08:53:22 +02:00
Jelle Zijlstra d3b8f98696 tempfile.rst: Fix some typos (GH-610) 2017-03-11 09:34:55 -08:00
Xiang Zhang 0710d75425 bpo-29770: remove outdated PYO related info (GH-590) 2017-03-11 13:02:52 +08:00
Mariatta 70ee0cd5c2 bpo-29784: Fix the reference to shutil.copy in the docs (GH-602) 2017-03-10 18:17:21 -08:00
Ivan Levkivskyi 4b2a2a425a bpo-28810: Document changes to CALL_FUNCTION opcodes (GH-250) 2017-03-10 14:52:35 -08:00
Ivan Levkivskyi 7e52c3e7ae bpo-28810: Document BUILD_TUPLE_UNPACK_WITH_CALL bytecode added in 3.6 (GH-239) 2017-03-10 14:16:44 -08:00
Serhiy Storchaka 8606e9524a bpo-28231: The zipfile module now accepts path-like objects for external paths. (#511) 2017-03-08 14:37:51 +02:00
Serhiy Storchaka c45cd167d4 bpo-28230: Document the pathlib support in tarfile and add tests. (#512) 2017-03-08 10:32:44 +02:00
Serhiy Storchaka 8f6b344d36 bpo-28682: Added support for bytes paths in os.fwalk(). (#489) 2017-03-07 14:33:21 +02:00
Adam Niederer b4e1b92aab Docs: Add note regarding "reversed" flag in heapq.merge (#300)
The docs for `heapq.merge` are a little misleading. Iterables passed
into heapq.merge with the reversed flag enabled must be sorted from
largest to smallest to achieve the desired sorting effect, but the
previous paragraph states that they should be sorted from smallest
to largest.
2017-03-05 08:56:05 -08:00
J. W 6abaed0dda Correct spelling "instanciate" (#465) 2017-03-04 17:51:08 -05:00
Ivan Levkivskyi 0705f66eb3 bpo-26213: Document _UNPACK bytecodes and BUILD_MAP changes (#238) 2017-03-03 13:46:39 -08:00
Mariatta 8eb531d9db bpo-29709: Improve Boolean Operations documentation (#433)
Change False into false, and True into true.
2017-03-03 13:16:29 -08:00
Marco Buttu 5dfccb06dc bpo-29455: Mention coverage.py in trace module documentation (#261) 2017-03-03 12:42:04 -08:00
David Ellis 85b8d01c91 bpo-29623: Make PathLike objects work with ConfigParser.read() (#242) 2017-03-03 20:14:27 +03:00
Matthias Bussonnier c643a967dd Add Python version since deprecation in base64 methods. (#33)
Allow developers to not have to either test on N Python versions or
looked through multiple versions of the docs to know whether they can
easily update.
2017-03-02 17:21:26 +03:00
Marco Buttu b2a7c2f986 bpo-27200: fix configparser, copyreg and ctypes doctests (#240) 2017-03-02 14:02:43 +03:00
Alex Gaynor 275104e86b In SSL module version examples, don't use a legacy version. (#381) 2017-03-02 11:23:19 +01:00
Mariatta da62373b0d email.compat32-message.rst: Fix typo in the word `message` (GH-379) 2017-03-01 06:20:16 -08:00
Berker Peksag f5184745a5 Tweak subprocess.STARTUPINFO documentation (#347)
* Document STARTUPINFO constructor
* Move versionchanged directive to above of attributes
2017-03-01 12:51:55 +03:00
Alex Gaynor 1cf2a809b1 Fixed a handful of typos (GH-343) 2017-02-28 19:26:56 -08:00
Kartik Anand 626584284e correct documentation for enum.html (#358) 2017-02-28 21:07:18 +01:00
Xiang Zhang 267b9d2fa8 bpo-7769: enable xmlrpc.server.SimpleXMLRPCDispatcher.register_function used as decorator (GH-231) 2017-02-28 17:12:52 +08:00
Berker Peksag 370f7a956c bpo-24241: Add versionchanged directive to the documentation (#342) 2017-02-27 19:13:41 +03:00
Mariatta 091b84f23a Asyncio documentation: remove `self` from method signatures (GH-334) 2017-02-27 05:44:15 -08:00
Xiang Zhang 210d6a9f95 bpo-29662: fix wrong indentation in timeit.Timer's doc (GH-332) 2017-02-27 13:42:01 +08:00
Sayan Chowdhury d5c11f7ace bpo-28624: Add a test that checks that cwd parameter of Popen() accepts PathLike objects (#157) 2017-02-26 20:06:10 +03:00
Berker Peksag fe70d924bb bpo-29121: Remove outdated documentation about transactions (#313)
Patch by Aviv Palivoda.
2017-02-26 18:31:12 +03:00
Marco Buttu ed6795e46f bpo-22594: Add a link to the regex module in re documentation (GH-241) 2017-02-26 07:26:23 -08:00
Subhendu Ghosh ae160bba20 bpo-26128: Added __init__to subprocess.STARTUPINFO (#171)
The Windows-specific subprocess.STARTUPINFO class now accepts
keyword-only arguments to its constructor to set the various
data attributes.

Patch by Subhendu Ghosh.
2017-02-26 00:59:05 +10:00
Ratnadeep Debnath 21024f0662 bpo-16285: Update urllib quoting to RFC 3986 (#173)
* bpo-16285: Update urllib quoting to RFC 3986

urllib.parse.quote is now based on RFC 3986, and hence
includes `'~'` in the set of characters that is not escaped
by default.

Patch by Christian Theune and Ratnadeep Debnath.
2017-02-25 19:00:28 +10:00
David Steele e3ce69522f bpo-24241: Improve preferred webbrowser handling (#85)
- Add 'preferred' argument to webbrowser.register
- Use xdg-settings to specify preferred X browser

The first change replaces the existing undocumented tri-state
'try_order' parameter with the documented boolean keyword-only
'preferred' parameter. Setting it to True places the browser at the
front of the list, preferring it as the return to a subsequent get() call.

The second change adds a private `_os_preferred_browser` setting
and then uses that to make the default browser reported by
`xdg-settings` first in the try list when running under X (or
another environment that sets the `DISPLAY` variable).
This avoids the problem where the first entry in the tryorder
queue otherwise defaults to xdg-open, which doesn't support
the "new window" option.
2017-02-25 14:47:38 +10:00
Barry Warsaw fba79dc568 bpo-25008: Deprecate smtpd and point to aiosmtpd (#274)
* bpo-25008: Deprecate smtpd and point to aiosmtpd.

* Simplify the aiosmtpd URL.
2017-02-24 20:05:59 +01:00
Arne de Laat 324c5d8ca6 bpo-28911: Clarify the behaviour of assert_called_once_with. (#251) 2017-02-23 15:57:25 +01:00
INADA Naoki cb41b2766d bpo-29463: Add docstring field to some AST nodes. (#46)
* bpo-29463: Add docstring field to some AST nodes.

ClassDef, ModuleDef, FunctionDef, and AsyncFunctionDef has docstring
field for now.  It was first statement of there body.

* fix document.  thanks travis!

* doc fixes
2017-02-22 16:31:59 +01:00
Matthias Bussonnier 0899b98095 bpo-28814: Undeprecate inadvertently deprecated inspect functions. (#122)
Nick Coghlan said on bpo-28814:

> inspect.getargvalues() and inspect.formatargvalues() were deprecated
> in Python 3.5 as part of implementing bpo-20438

> This is incorrect, as these are *frame* introspection related functions,
> not callable introspection ones. The documentation and implementation
> layout is confusing though, as they're interleaved with the callable
> introspection operation

This commit undeprecates these functions and adds a note to ignore
previous deprecation notices.
2017-02-22 08:45:51 +03:00
Matthias Bussonnier 8fb1f6e039 bpo-29554: Improve docs for pstat module and profile. (#88)
Clarify that methods take a string which is interpreted as a regex,
not a regex object.

Also clarify what the old `-1`, `0`, `1` and `2` options were.
2017-02-21 08:30:00 +03:00
Berker Peksag d4d48743ac Tweak PEP 519 documentation in stdlib (#163)
* Drop duplicate work 'object' in lzma docs
* Fix typo in os docs: fpr -> for
2017-02-19 03:17:35 +03:00
Barry Warsaw 8c130d7f81 bpo-22807: Expose platform UUID generation safety information. (#138)
bpo-22807: Expose platform UUID generation safety information.
2017-02-18 15:45:49 -05:00
Eric Appelt 23557d59b8 bpo-29026: Clarify documentation of time.time (#34)
* bpo-29026: Clarity documentation of time.time

Clarify the documentation of time.time by more
precisely defining what is meant by "seconds since
the epoch" on most platforms. Additionally explain
how gmtime and localtime may be used to extract
calendar components and convert to a more common
date format.

* bpo-29026: Minor improvements for time.time doc

* bpo-29026: Consistency fixes for time.time doc
2017-02-16 11:00:45 +01:00
Mariatta 36da1c3589 bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107) 2017-02-15 11:37:18 -08:00
David Wilemski 6de2b7817f bpo-29557: Remove ambiguous line in binhex docs (#90)
"appears to not work in all cases" does not inspire confidence in this
module. I can find no context for what bug this was referencing so it
should be removed.
2017-02-15 01:37:49 +03:00
Mariatta 3110a379bb bpo-29474: Improve documentation for weakref.WeakValueDictionary (#10)
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-12 08:17:50 -08:00
Berker Peksag ee0ee9ae8e Issue #29441: Merge from 3.6 2017-02-07 11:28:19 +03:00
Berker Peksag 088507644e Issue #29441: Merge from 3.5 2017-02-07 11:27:48 +03:00
Berker Peksag f59286794b Issue #29441: Update examples to use async and await keywords in asyncio-task.rst 2017-02-07 11:27:09 +03:00
Mariatta Wijaya 743376f45e Issue #29371: merge with 3.6 2017-02-06 20:18:39 -08:00
Mariatta Wijaya e39262ccc3 Issue #29371: merge with 3.5 2017-02-06 20:16:58 -08:00
Mariatta Wijaya 81b8977349 Issue #29371: Clarify bitwise OR operation in doctest option flags. 2017-02-06 20:15:01 -08:00
Raymond Hettinger 0fa47469a9 merge 2017-02-06 07:15:57 -08:00
Raymond Hettinger d0b9158666 Substitute a more readable f-string 2017-02-06 07:15:31 -08:00
Berker Peksag 7b620a448e Merge from 3.6 2017-02-06 13:37:45 +03:00
Berker Peksag d93c4de522 Fix usage of data directive 2017-02-06 13:37:19 +03:00
Berker Peksag 09f939d2c4 Issue #29198: Merge from 3.6 2017-02-04 09:35:10 +03:00
Berker Peksag 5a001eea5b Issue #29198: Merge from 3.5 2017-02-04 09:34:48 +03:00
Berker Peksag 5702fb7b4d Issue #29198: Fix indentation and markup in typing.rst
Patch by Jelle Zijlstra.
2017-02-04 09:34:16 +03:00
Berker Peksag b1d3f661d7 Issue #29198: Merge from 3.6 2017-02-04 09:19:04 +03:00
Berker Peksag 14169b2a89 Issue #29198: Merge from 3.5 2017-02-04 09:18:42 +03:00
Berker Peksag 38962a6fe2 Issue #29198: Document typing.AsyncGenerator
Patch by Jelle Zijlstra.
2017-02-04 09:18:11 +03:00
Victor Stinner 3f2d10132d Issue #29300: Convert _struct module to Argument Clinic
* The struct module now requires contiguous buffers.
* Convert most functions and methods of the _struct module to Argument Clinic
* Use "Py_buffer" type for the "buffer" argument. Argument Clinic is
  responsible to create and release the Py_buffer object.
* Use "PyStructObject *" type for self to avoid explicit conversions.
* Add an unit test on the _struct.Struct.unpack_from() method to test passing
  arguments as keywords.
* Rephrase docstrings.
* Rename "fmt" argument to "format" in docstrings and the documentation.

As a side effect, functions and methods which used METH_VARARGS calling
convention like struct.pack() now use the METH_FASTCALL calling convention
which avoids the creation of temporary tuple to pass positional arguments and
so is faster. For example, struct.pack("i", 1) becomes 1.56x faster (-36%)::

    $ ./python -m perf timeit \
        -s 'import struct; pack=struct.pack' 'pack("i", 1)' \
        --compare-to=../default-ref/python
    Median +- std dev: 119 ns +- 1 ns -> 76.8 ns +- 0.4 ns: 1.56x faster (-36%)
    Significant (t=295.91)

Patch co-written with Serhiy Storchaka.
2017-02-02 12:09:30 +01:00
Berker Peksag ebf8a6d9b0 Issue #29407: Merge from 3.6 2017-02-01 22:38:12 +03:00
Berker Peksag c6fe419d1b Issue #29407: Merge from 3.5 2017-02-01 22:37:49 +03:00