Commit Graph

8632 Commits

Author SHA1 Message Date
Alexander Belopolsky 018d353c1c Closes issue bpo-5288: Allow tzinfo objects with sub-minute offsets. (#2896)
* Closes issue bpo-5288: Allow tzinfo objects with sub-minute offsets.

* bpo-5288: Implemented %z formatting of sub-minute offsets.

* bpo-5288: Removed mentions of the whole minute limitation on TZ offsets.

* bpo-5288: Removed one more mention of the whole minute limitation.

Thanks @csabella!

* Fix a formatting error in the docs

* Addressed review comments.

Thanks, @haypo.
2017-07-31 10:26:50 -04:00
Vinay Sajip 2543f50033 bpo-30522: Implemented a method to allow setting a logging.StreamHander's stream. (GH-2921) 2017-07-30 10:41:45 +01:00
Peter Thomassen caa1280d1e bpo-30803: clarify truth value testing documentation (#2508)
Initial patch by Peter Thomassen.
2017-07-29 15:18:13 -04:00
Yuval Langer 6fcb69dad5 Fix trivial typo in multiprocessing documentation (GH-2930) 2017-07-28 10:39:35 -07:00
Utkarsh Upadhyay 8e45318b0d bpo-30302: Update WhatsNew and documentation. (#2929)
* Update 'Porting to .37' section.

* Fix a minor example in the doc.
2017-07-28 14:42:56 +02:00
lf 627d2c8e8d Add the link to asyncio source code in the docs (GH-2373) 2017-07-25 16:03:51 -07:00
Utkarsh Upadhyay cc5a65cd90 bpo-30302 Make timedelta.__repr__ more informative. (#1493) 2017-07-25 23:51:33 +02:00
Eli Boyarski 26248ef58d bpo-30456: Clarify example for duplicates in second argument of isinstance (GH-1699) 2017-07-24 03:39:07 +03:00
靳阳 fff2a21057 Fix typo in Turtle Docs: yingyang -> yinyang (GH-2770) 2017-07-20 06:58:40 -07:00
Vitor Pereira ba75af7130 bpo-30794: added kill() method to multiprocessing.Process (#2528)
* bpo-30794: added kill() method to multiprocessing.Process

* Added entries to documentation and NEWS

* Refactored test_terminate and test_kill

* Fix SIGTERM and SIGKILL being used on Windows for the tests

* Added "versionadded" marker to the documentation

* Fix trailing whitespace in doc
2017-07-18 17:34:23 +02:00
Łukasz Rogalski be37beb05f Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2706) 2017-07-14 15:23:39 -04:00
Manvisha Kodali 67ba4fa467 bpo-26506: hex() documentation: mention %x % int (GH-2525) 2017-07-06 12:30:58 -07:00
Vinay Sajip 0653fba51c bpo-30862: Updated Logger.setLevel documentation. (GH-2604) 2017-07-06 17:51:28 +01:00
csabella 246ff3bd00 bpo-6691: Pyclbr now reports nested classes and functions. (#2503)
Original patch by Guilherme Polo.  Revisions by Cheryl Sabella.
2017-07-03 21:31:25 -04:00
Antoine Pitrou 13e96cc596 Fix bpo-30596: Add close() method to multiprocessing.Process (#2010)
* Fix bpo-30596: Add close() method to multiprocessing.Process

* Raise ValueError if close() is called before the Process is finished running

* Add docs

* Add NEWS blurb
2017-06-24 19:22:23 +02:00
Victor Stinner f87b85f808 bpo-21071: struct.Struct.format type is now str (#845) 2017-06-23 15:11:12 +02:00
Benjamin Peterson 279a96206f bpo-30736: upgrade to Unicode 10.0 (#2344)
Straightforward. While we're at it, though, strip trailing whitespace from generated tables.
2017-06-22 22:31:08 -07:00
khyox 6580c19bbb bpo-30619: Clarify typing.Union documentation (GH-2326)
When a class and its subclass are present, the latter is skipped.
2017-06-22 06:14:57 -07:00
Kojo Idrissa 5200a7c7f9 bpo-29933: Improve set_write_buffer_limits description (GH-2262)
Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.
2017-06-20 12:32:00 -07:00
Victor Stinner 5ea4c06773 bpo-30054: Expose tracemalloc C API (#1236)
* Make PyTraceMalloc_Track() and PyTraceMalloc_Untrack() functions
  public (remove the "_" prefix)
* Remove the _PyTraceMalloc_domain_t type: use directly unsigned
  int.
* Document methods

Note: methods are already tested in test_tracemalloc.
2017-06-20 17:46:36 +02:00
Serhiy Storchaka 26cb4657bc bpo-29755: Fixed the lgettext() family of functions in the gettext module. (#2266)
They now always return bytes.

Updated the gettext documentation.
2017-06-20 17:13:29 +03:00
Xiang Zhang 116dd5eba6 bpo-30176: Add missing curses cell attributes constants (GH-1302) 2017-06-15 20:20:07 -07:00
Milan Oberkirch 8c3f05e9f0 bpo-30436: Raise ModuleNotFoundError for importlib.util.find_spec() when parent isn't a package (GH-1899)
Previously AttributeError was raised, but that's not very reflective of the fact that the requested module can't be found since the specified parent isn't actually a package.
2017-06-14 14:34:50 -07:00
terryjreedy 188aedf8bb bpo-25514: Improve IDLE's connection refused message (#2177)
When IDLE fail to start because the socket connection fails, direct people to a new subsection of the IDLE doc listing various causes and remedies.
2017-06-13 21:32:16 -04:00
Ben Hoyt 184bd82ba8 bpo-30659 : Use ** for kwargs in namedtuple._replace() signature (GH-2173) 2017-06-13 12:20:51 -07:00
Antoine Pitrou d79c1d4a94 Mention how to disable signal fd wakeup (#2140) 2017-06-13 10:14:09 +02:00
Serhiy Storchaka 1efbf92e90 bpo-11822: Improve disassembly to show embedded code objects. (#1844)
The depth argument limits recursion.
2017-06-11 14:09:39 +03:00
Benjamin Peterson fdfca5f0ff remove extra word (#2101) 2017-06-11 00:24:38 -07:00
Benjamin Peterson dc1da9adc3 clarify recv() and send() on SSLObject (#2100)
SSLObject has recv() and send(), but they don't do any network io.
2017-06-11 00:15:14 -07:00
csabella e5f6e86c48 bpo-25409: Clarify fnmatch and fnmatchcase documentation (GH-1535)
Mention that fnmatchcase does not call normcase, and fnmatch does.
2017-06-09 21:42:11 -07:00
Jim Fasarakis-Hilliard 74921ed894 bpo-30335: Add deprecation alias entry for assertNotRegexpMatches (GH-1536)
Document that assertNotRegexpMatches is a deprecated alias for assertNotRegex.
2017-06-09 13:27:20 -07:00
Marco Buttu 5eb7075915 bpo-30217: Add the operators ~ and | to the index (#1502) 2017-06-09 17:28:27 +03:00
Chandan Kumar 63c2c8ac17 bpo-19180: Updated references for RFC 1750, RFC 3280 & RFC 4366 (GH-148)
* RFC 1750 has been been obsoleted by RFC 4086.
* RFC 3280 has been obsoleted by RFC 5280.
* RFC 4366 has been obsoleted by RFC 6066.
2017-06-09 19:43:58 +10:00
adisbladis 824f687912 bpo-24755: Document asyncio.wrap_future (GH-603) 2017-06-08 23:28:59 -07:00
wim glenn 53f2af1655 bpo-30583: Fix typo in datetime dateutil documentation (GH-1972)
Replace `datetuil` into `dateutil`
2017-06-06 10:54:41 -07:00
Serhiy Storchaka 5cefb6cfdd bpo-25324: Move the description of tokenize tokens to token.rst. (#1911) 2017-06-06 18:43:35 +03:00
Vinay Sajip 6260d9f203 bpo-30520: Implemented pickling for loggers. (#1956)
Implemented pickling for loggers.
2017-06-06 16:34:29 +01:00
Oz N Tiram 8b7a4cc40e bpo-30095: Make CSS classes used by calendar.HTMLCalendar customizable (GH-1439)
Several class attributes have been added to calendar.HTMLCalendar that allow customization of the CSS classes used in the resulting HTML. This can be done by subclasses HTMLCalendar and overwriting those class attributes (Patch by Oz Tiram).
2017-06-06 11:35:59 +02:00
Antoine Pitrou 3c2817b688 Fix bpo-30526: Add TextIOWrapper.reconfigure() and a TextIOWrapper.write_through attribute (#1922)
* Fix bpo-30526: Add TextIOWrapper.reconfigure()

* Apply Nick's improved wording

* Update Misc/NEWS
2017-06-03 12:32:28 +02:00
Jamiel Almeida ae8750bca8 bpo-24899: Add comparison table for os.path -> pathlib (GH-1753) 2017-06-02 11:36:02 -07:00
Matthias Bussonnier cdb89cd72c bpo-29660: traceback: Document that etype is ignored in some places. (GH-344) 2017-06-01 14:54:01 -07:00
Julien 0737ee2067 bpo-30499: Remove a deprecated note about sets. (GH-1848) 2017-06-01 07:02:21 -07:00
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