Commit Graph

20670 Commits

Author SHA1 Message Date
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 12b1c18098 bpo-30354: Update data model documentation for super() (GH-1561)
The data model section of the language reference was written well
before the zero-argument form of super() was added.

To avoid giving the impression that they're doing something
unusual, this updates the description of `__new__` and `__init__`
to use the zero-argument form.

Patch by Cheryl Sabella.
2017-05-15 13:42:00 +10: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
Serhiy Storchaka 7e19dbc92e bpo-28974: `object.__format__(x, '')` is now equivalent to `str(x)` (#506)
rather than `format(str(self), '')`.
2017-05-13 12:40:52 +03: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
Xiang Zhang 2ddf5a19c3 bpo-30281: Fix the default value for stop in PySlice_Unpack() (#1480) 2017-05-10 18:19:41 +08:00
Serhiy Storchaka 6d336a0279 bpo-30285: Optimize case-insensitive matching and searching (#1482)
of regular expressions.
2017-05-09 23:37:14 +03:00
Serhiy Storchaka f93234bb8a bpo-30024: Circular imports involving absolute imports with binding (#1264)
a submodule to a name are now supported.
2017-05-09 22:31:05 +03: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 f34c685020 Fix a trivial typo in global section (#1497) 2017-05-08 04:36:29 -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
Wieland Hoffmann 80a3da4d4a Improve the grammar in windows.rst (GH-1330) 2017-04-28 09:12:57 -07:00
Marco Buttu e65fcde85a bpo-27200: Fix several doctests (GH-604) 2017-04-27 15:23:34 +03:00
Jesse Gonzalez 6fde770e4e Use the correct name for ISO in Unicode HOWTO. (#1312) 2017-04-26 22:12:17 -07:00
Louie Lu 88c38b32b7 bpo-28415: Note 0 conversion different between Python and C (#885) 2017-04-27 11:36:35 +08: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
csabella 26896f2832 bpo-29751: Improve PyLong_FromString documentation (GH-915) 2017-04-23 20:54:08 -07:00
Serhiy Storchaka 85157cd89a bpo-15718: Document the upper bound constrain on the __len__ return value. (#1256) 2017-04-23 08:37:58 +03:00
Serhiy Storchaka 997a4adea6 Remove outdated note about constraining of the bit shift right operand. (#1258)
The constrain was removed in bpo-29816.
2017-04-22 21:50:09 +03:00
Louie Lu 7fae81e167 Fix trailing colon and newline in test.rst (#1250) 2017-04-22 09:46:18 +03:00
Sebastian Vetter d1ae24e888 Correct the README link in Unix install docs (#1245) 2017-04-21 10:24:57 -07:00
Berker Peksag 6dbdedb0b1 bpo-10379: Add %char examples to locale.format() docs (GH-1145) 2017-04-20 07:38:43 +03:00
Berker Peksag 8526fb74ed Remove redundant comma in argparse HOWTO (#1141)
Reported by Sean Canavan on docs@p.o.
2017-04-20 07:29:35 +03:00
Mariatta 8312fba0a1 Minor grammar fixes (GH-1174) 2017-04-18 18:59:47 -07:00
cocoatomo 992ae6444c Fix minor typos (GH-1173) 2017-04-18 17:38:26 -07:00
Serhiy Storchaka fdbd01151d bpo-10076: Compiled regular expression and match objects now are copyable. (#1000) 2017-04-16 10:16:03 +03:00
cocoatomo eaeda64c2f bpo-19225: Remove duplicated description for standard warning categories (GH-1068) 2017-04-15 05:06:02 +03:00
Michael Seifert 0dc5c3169d bpo-30059: Include Py_Ellipsis in C API documentation (#1018) 2017-04-14 22:18:35 +03:00
Ryan Gonzalez f9f87f0934 bpo-11913: Add README.rst to the distutils standard READMEs list (#563) 2017-04-14 11:00:25 +02: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
cocoatomo e8c763128f bpo-19225: Add a table of warning names and missed exception names in C API doc (#881)
Move the `.. index` directive to more appropriate place.
2017-04-02 13:45:40 +03: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
csabella 64c887ab3a bpo-26947: DOC: clarify wording on hashable in glossary (#948) 2017-04-01 19:50:47 -07:00
cocoatomo cdcac039fb bpo-29952: Use usual terminology of dict (GH-917)
s/keys and elements/keys and values/
2017-03-31 14:48:49 +09:00
Mariatta 33db068dac bpo-29928: Add f-string to the Glossary (GH-864) 2017-03-30 12:12:18 -07:00
s-sanjay 16f852345b bpo-29913: deprecate compare_networks() in documentation (GH-865) 2017-03-30 15:44:29 +08:00
Serhiy Storchaka 84b8e92e46 bpo-29918: Add missed "const" modifiers in C API documentation. (#846) 2017-03-30 10:01:03 +03: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
Serhiy Storchaka 0a58f72762 bpo-24821: Fixed the slowing down to 25 times in the searching of some (#505)
unlucky Unicode characters.
2017-03-30 09:11:10 +03:00
csabella c3c7ef0885 bpo-29917: DOC: Remove link from PyMethodDef (#890) 2017-03-29 17:27:50 -07: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
Amit Kumar 0ae7c8bd61 bpo-16011 clarify that 'in' always returns a boolean value 2017-03-28 10:13:01 -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
cocoatomo f8beb9831a bpo-29888: Fix the link referring to the "Python download page" (GH-824) 2017-03-26 13:32:24 -04: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
Serhiy Storchaka aefa7ebf0f bpo-6532: Make the thread id an unsigned integer. (#781)
* bpo-6532: Make the thread id an unsigned integer.

From C API side the type of results of PyThread_start_new_thread() and
PyThread_get_thread_ident(), the id parameter of
PyThreadState_SetAsyncExc(), and the thread_id field of PyThreadState
changed from "long" to "unsigned long".

* Restore a check in thread_get_ident().
2017-03-23 14:48:39 +01: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
Ivan Levkivskyi fad7f15606 Remove an outdated statement in execution model docs (GH-754) 2017-03-22 17:54:53 -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
Serhiy Storchaka c85a26628c bpo-28749: Fixed the documentation of the mapping codec APIs. (#487)
Added the documentation for PyUnicode_Translate().
2017-03-19 08:15:17 +02: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