a33f2c2bae
bpo-27032, bpo-37328: Document removing HTMLParser.unescape(). (GH-22288)
2020-09-17 11:49:01 +03:00
7219e27087
Enum: make `Flag` and `IntFlag` members iterable (GH-22221)
2020-09-16 13:01:00 -07:00
a5634c4067
bpo-41746: Add type information to asdl_seq objects (GH-22223)
...
* Add new capability to the PEG parser to type variable assignments. For instance:
```
| a[asdl_stmt_seq*]=';'.small_stmt+ [';'] NEWLINE { a }
```
* Add new sequence types from the asdl definition (automatically generated)
* Make `asdl_seq` type a generic aliasing pointer type.
* Create a new `asdl_generic_seq` for the generic case using `void*`.
* The old `asdl_seq_GET`/`ast_seq_SET` macros now are typed.
* New `asdl_seq_GET_UNTYPED`/`ast_seq_SET_UNTYPED` macros for dealing with generic sequences.
* Changes all possible `asdl_seq` types to use specific versions everywhere.
2020-09-16 19:42:00 +01:00
83f6dcd207
[doc] Minor improvements to is_typeddict (GH-22280)
...
1. The check is on the type
2. Add link to TypeDict
2020-09-16 08:06:23 -07:00
0705ec8a14
bpo-41792: Add is_typeddict function to typing.py (GH-22254)
...
Closes issue41792.
Also closes https://github.com/python/typing/issues/751 .
2020-09-15 21:58:32 -07:00
47f6ec4c09
Doc: Fix broken manpage link (GH-21937)
...
sigprocmask is in section 2, not 3.
2020-09-15 20:26:06 -03:00
ac0333e1e1
Fix all Python Cookbook links ( #22205 )
2020-09-15 21:13:26 +01:00
5531269f69
Improve the description of difflib in the documentation (GH-22253)
...
From "can produce difference information in various formats ..."
to " can produce information about file differences in various formats ..."
Automerge-Triggered-By: @Mariatta
2020-09-15 12:20:49 -07:00
7bcc6456ad
bpo-41776: Revise example of "continue" in the tutorial documentation (GH-22234)
...
Revise example of "continue" in the tutorial documentation
2020-09-15 09:39:29 -04:00
542e1df2b0
bpo-40721: add note about enum member name case (GH-22231)
...
* UPPER_CASE preferred as enum members are constants
2020-09-14 13:32:44 -07:00
8f2b991eef
bpo-41646: Mention path-like objects support in the docs for shutil.copy() (GH-22208)
2020-09-14 20:28:46 +01:00
efcbe786cf
Fix a typo in locale Docs ( #22233 )
2020-09-14 20:36:34 +03:00
457d4e97de
bpo-41513: Add docs and tests for hypot() (GH-22238)
2020-09-13 23:33:41 -07:00
94bfdee25d
bpo-41778: Change a punctuation on documentation. (GH-22229)
...
On this paragrapah the clarification about IIS7 seems there's not
connection beacuase is in other sentence. Move the punctuation
to connect both the last sentence with the information in the
parenthesis.
I think the NEWS is not necessary here.
Automerge-Triggered-By: @ericvsmith
2020-09-13 14:05:44 -07:00
b48389d950
bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763)
...
`None` doesn't work:
```python
>>> import tempfile
>>> tempfile.TemporaryFile(buffering=None)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/home/sergey/tmp/cpython-dev/Lib/tempfile.py", line 607, in TemporaryFile
return _io.open(fd, mode, buffering=buffering,
TypeError: 'NoneType' object cannot be interpreted as an integer
```
Automerge-Triggered-By: @vsajip
2020-09-13 10:59:01 -07:00
c75330605d
bpo-41672: Fix type mismatches in imaplib docs (GH-22207)
2020-09-12 16:58:56 +09:00
fb27187203
[doc] struct: update note about network byte order form to be more helpful (GH-22201)
...
Update the sentence to provide some context on why network byte order is defined as big endian.
2020-09-11 08:20:12 -07:00
3304cbd990
Doc: Fix alphabetical ordering of removeprefix/suffix. (GH-22194)
2020-09-11 08:59:02 +09:00
06d0b8b67e
bpo-37149: Change Shipman tkinter link from archive.org to TkDocs (GH-22188)
...
The new link responds much faster and begins with a short explanation of the status of the doc.
2020-09-10 16:04:20 -04:00
1e874d5bec
Update logging documentation to tidy up formatting (GH-22173)
2020-09-10 11:50:23 +01:00
788b79fa7b
[doc] Remove superfluous comment about equal in f-strings (GH-22006)
...
Automerge-Triggered-By: @kushaldas
2020-09-09 23:33:13 -07:00
7a797a3967
Add missing colon to IDLE doc markup (GH-22007)
2020-09-09 18:17:14 -04:00
76553e5d2e
Add minor clarification in logging documentation. (GH-22167)
2020-09-09 11:21:22 +01:00
1e2f051a61
bpo-41726: Update the refcounts info of PyType_FromModuleAndSpec in refcounts.dat (GH-22112)
...
Update refcounts info of PyType_FromModuleAndSpec in refcounts.dat
2020-09-09 11:48:44 +02:00
594f0ce73b
[doc] Fix padding in timeit (GH-22152)
...
Compare -p and -u options help in rendered output to see the difference.
2020-09-08 16:39:19 -07:00
207c321f13
bpo-40744: Drop support for SQLite pre 3.7.3 (GH-20909)
...
Remove code required to support SQLite pre 3.7.3.
Co-written-by: Berker Peksag <berker.peksag@gmail.com>
Co-written-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2020-09-07 22:26:54 +01:00
5bfd60fc2b
[doc] Add link to Generic in typing (GH-22125)
2020-09-06 22:29:38 -07:00
5371a464ce
closes bpo-41723: Fix an error in the py_compile documentation. (GH-22110)
2020-09-05 22:39:23 -05:00
2623868ede
[doc] Fix padding in some typing definitions (GH-22114)
...
Automerge-Triggered-By: @gvanrossum
2020-09-05 16:40:25 -07:00
1264d0465a
Fix documented Python version for venv --upgrade-deps (GH-22113)
...
Fixes incorrect Python version added for `venv` `--upgrade-deps` in #13100 . This feature was added in Python 3.9 not 3.8.
Relates to:
-
- 1cba1c9aba
2020-09-05 13:53:47 -07:00
51b84f8e96
bpo-38585: Remove references to defusedexpat (GH-22095)
...
defusedexpat is not maintained.
2020-09-04 13:57:48 -07:00
306cfb3a37
bpo-40486: Specify what happens if directory content change diring iteration (GH-22025)
2020-09-04 21:19:30 +03:00
cdbff3527c
[doc] Update documentation on logging optimization. (GH-22075)
2020-09-03 19:44:12 +01:00
8516060076
[doc] Fix a typo in the graphlib docs ( #22030 )
2020-09-03 11:00:10 +01:00
e223d06a8b
bpo-39883: Use BSD0 license for code in docs (GH-17635)
...
The PSF board approved this use.
2020-09-02 22:22:36 -07:00
5a4a963a6c
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047)
2020-09-02 15:29:38 +01:00
51fece1bb8
bpo-41685: Don't pin setuptools version anymore in Doc/Makefile (GH-22062)
...
setuptools 50.0.2 is now compatible with Python 3.10:
https://github.com/pypa/setuptools/pull/2361
2020-09-02 13:11:21 +02:00
c0d5c131d9
bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)
2020-09-02 12:29:31 +02:00
1d25f5bf7b
Remove reference to Boa Constructor. (GH-22012)
2020-09-01 22:22:55 -05:00
dea82b6731
[doc] Remove references to PyChecker. (GH-22011)
2020-09-01 22:21:12 -05:00
700fa1b836
Note the buffer slots can be set with PyType_Spec with the unlimited API. (GH-22031)
...
Follow up to f7c4e23642
2020-09-01 20:36:42 -05:00
f5a16b4dbf
[doc] Add link to FileHandler in logging (GH-21940)
...
Co-authored-by: Andrés Delfino <adelfino@onapsis.com>
2020-09-01 13:59:46 +01:00
a4c4e17f95
bpo-41685: Temporarily pin setuptools to 49.2.1 in Docs venv. (GH-22038)
...
See https://github.com/pypa/setuptools/pull/2361
2020-09-01 05:40:27 -04:00
3584d4b64a
[doc] Document VIRTUAL_ENV environment variable (GH-21970)
2020-09-01 07:07:29 +01:00
c3a651ad25
[doc] Fix markup in logging (GH-22008)
2020-08-30 21:36:58 +01:00
c68c5af2dc
Improve asyncio-dev 'Concurrency and Multithreading' docs (GH-20882)
...
I added some information to the `Concurrency and Multithreading` section of the `Developing with asyncio` guide.
This is all information that would have helped me when I started using asyncio. I incorrectly assumed that `loop.call_soon_threadsafe()` and `run_coroutine_threadsafe()` could be called from a thread in a process separate from the one that the event loop is running in. Explicitly stating that this will not work will probably help some people starting out with asyncio in the future.
I also added references to some other functions that can be used for inter-process communication without blocking the event loop. The section already mentions running blocking code in a ThreadPoolExecutor, but I think listing these other options in this section will also be helpful.
2020-08-29 16:47:38 -07:00
8784d3300e
Fix error in argparse documentation example (GH-17399)
...
Automerge-Triggered-By: @rhettinger
2020-08-28 11:47:58 -07:00
d9a966ae08
bpo-38787: Clarify docs for PyType_GetModule and warn against common mistake (GH-20215)
2020-08-27 15:36:48 +02:00
398575c210
bpo-41634: Fix a typo in the curses documentation (GH-21958)
2020-08-27 16:58:16 +05:30
b260635b3d
Add missing word (GH-21936)
...
"data to lost" -> "data to be lost"
2020-08-27 02:49:14 +02:00
8c58d2a216
bpo-41624: fix documentation of typing.Coroutine (GH-21952)
2020-08-27 02:42:37 +02:00
802726acf6
Document vars behavior when __dict__ is missing ( #21466 )
2020-08-21 19:29:34 -03:00
7173fc84e6
bpo-41573: Update release versions in General FAQ (GH-21915)
2020-08-21 18:28:54 -04:00
12695f4c6d
Doc: add a missing period (GH-21819)
2020-08-20 22:08:37 +02:00
2ce39631f6
bpo-40994: Ungroup items in collections.abc documentation for improved clarity (GH-21880)
...
Use a less surprising document structure.
Automerge-Triggered-By: @csabella
2020-08-20 03:30:21 -07:00
0be7c216e1
Fix grammar in Doc/tutorial/controlflow.rst (GH-21885)
...
Automerge-Triggered-By: @csabella
2020-08-19 04:29:47 -07:00
1abeda80f7
bpo-40204: Fix duplicated productionlist names in the doc (GH-21900)
...
Sphinx 3 disallows having more than one productionlist markup with
the same name. Simply remove names in this case, since names are not
shown anyway. For example, fix the Sphinx 3 warning:
Doc/reference/introduction.rst:96: duplicate token description
of *:name, other instance in reference/expressions
2020-08-17 08:41:42 +02:00
fbf43f051e
bpo-41521: Rename blacklist parameter to not_exported (GH-21824)
...
Rename "blacklist" parameter of test.support.check__all__() to
"not_exported".
2020-08-17 07:20:40 +02:00
fa5d725198
Fix typo in typing doc (GH-21879)
...
Automerge-Triggered-By: @gvanrossum
2020-08-14 16:01:36 -07:00
bb0b08540c
bpo-40204: Fix reference to terms in the doc (GH-21865)
...
Sphinx 3 requires to refer to terms with the exact case.
For example, fix the Sphinx 3 warning:
Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case
sensitive match.made a reference to loader instead.
2020-08-14 12:20:05 +02:00
e55de68be3
bpo-41410: Fix outdated info in mkstemp docs (GH-21701)
...
Automerge-Triggered-By: @ericvsmith
2020-08-13 18:33:14 -07:00
a3eae43aee
Fixed comment about pathlib.link_to: it was added in 3.8, not changed. ( #21851 )
2020-08-13 17:33:56 -03:00
474652fe93
bpo-40204, doc: Fix syntax of C variables (GH-21846)
...
For example, fix the following Sphinx 3 errors:
Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 5]
void \*obj
-----^
Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*'
Invalid C declaration: Expected end of definition. [error at 8]
PyObject*
--------^
The modified documentation is compatible with Sphinx 2 and Sphinx 3.
2020-08-13 22:11:50 +02:00
0eb9deb4a6
bpo-41066: Update the comparison section for os vs pathlib (GH-21261)
2020-08-13 21:52:04 +02:00
d3ded08048
bpo-40204: Add :noindex: in the documentation (GH-21859)
...
Add :noindex: to duplicated documentation to fix "duplicate object
description" errors.
For example, fix this Sphinx 3 issue:
Doc/library/configparser.rst:1146: WARNING: duplicate object
description of configparser.ConfigParser.optionxform, other instance
in library/configparser, use :noindex: for one of them
2020-08-13 21:41:54 +02:00
20ae565bd2
bpo-41521: Replace denylist with blocklist is http.cookiejar doc (GH-21826)
...
The http.cookiejar module has is_blocked() and blocked_domains()
methods, so "blocklist" term sounds better than "denylist" in this
module.
Replace also denylisted with denied in test___all__.
2020-08-13 19:20:28 +02:00
46d10b1237
bpo-40204: Fix duplicates in the documentation (GH-21857)
...
Fix two Sphinx 3 issues:
Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'.
Declaration is 'PyBUF_ND'.
Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'.
Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'.
2020-08-13 19:16:02 +02:00
43577c01a2
bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858)
...
Use generic '.. object::' to declare markers, rather than abusing
'.. c:function::' which fails on Sphinx 3.
2020-08-13 19:15:38 +02:00
423e77d6de
bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844)
...
Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the
c_warn_on_allowed_pre_v3 option to make the documentation compatible
with Sphinx 2 and Sphinx 3.
2020-08-12 21:49:22 +02:00
0dfee33dfe
Fix typo (GH-21820)
2020-08-11 19:27:08 -03:00
76643c10ed
bpo-41475: Fix note in "What's new in 3.7" ( #21733 )
2020-08-11 18:33:25 +02:00
af3a6a8cae
Add PEP 573 additions to What's New (GH-21374)
2020-08-11 18:15:57 +02:00
e3c971ccfa
Add links to asttokens, leoAst, LibCST and parso to ast docs (GH-21773)
2020-08-11 07:07:49 -07:00
fabd7bb8e0
bpo-41521: Replace whitelist/blacklist with allowlist/denylist (GH-21822)
...
Automerge-Triggered-By: @tiran
2020-08-11 06:26:59 -07:00
4ce6faa6c9
bpo-16995: add support for base32 extended hex (base32hex) (GH-20441)
...
cc @pganssle
Automerge-Triggered-By: @pganssle
2020-08-10 07:48:20 -07:00
39042e00ab
bpo-41324 Add a minimal decimal capsule API ( #21519 )
2020-08-10 16:32:21 +02:00
e28b8c9387
bpo-35018: Sax parser should provide user access to lexical handlers (GH-20958)
...
Co-Authored-By: Jonathan Gossage <jgossage@gmail.com>
2020-08-09 12:50:53 +02:00
67acf74c4e
Doc: Add output to example code in programming FAQ (GH-21346)
...
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.html#how-do-i-write-a-function-with-output-parameters-call-by-reference ).
This patch make the output hint just like prefix code block.
2020-08-08 12:29:03 -07:00
82ca8fada1
bpo-41455: Provide a link to how the third generation is collected in the GC docs (GH-21703)
...
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2020-08-08 19:48:21 +01:00
705f145565
Doc: Add a link to tutorial page from `open()` doc (GH-21737)
...
Adds a link to the "Reading and Writing Files" page so users can
more easily discover how file handles are handled with the `with`
context manager vs without it.
2020-08-08 11:57:03 +09:00
46e19b61d3
bpo-41098: Doc: Add missing deprecated directives (GH-21162)
...
PyUnicodeEncodeError_Create has been deprecated with
`Py_DEPRECATED` macro. But it was not documented.
2020-08-07 16:31:53 +09:00
3405e05428
bpo-41440: add os.cpu_count() support for VxWorks RTOS (GH-21685)
2020-08-07 14:21:52 +09:00
270b4ad4df
bpo-36346: Doc: Update removal schedule of legacy Unicode (GH-21479)
...
See PEP 623 for detail.
2020-08-05 10:48:51 +09:00
da4e09fff6
bpo-36982: Add support for extended color functions in ncurses 6.1 (GH-17536)
...
Co-authored-by: Jeffrey Kintscher <websurfer@surf2c.net>
2020-08-03 23:51:33 -04:00
c36dbac588
bpo-41425: Make tkinter doc example runnable (GH-21706)
...
Co-authored-by: Ankit Chandawala <achandaw@amazon.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-08-03 00:03:48 -04:00
ecaf949cc4
bpo-41424: Remove extra words in Tkinter-Packer documentation (GH-21707)
2020-08-02 22:13:03 -04:00
ab72fdeb82
bpo-40979: refactored typing.rst; (mostly) same content, new sub-sections and ordering ( #21574 )
...
Also added PEP 585 deprecation notes.
2020-08-02 15:32:36 -07:00
ba18c0b13b
bpo-41426 Fix grammar in curses.getmouse() documentation (GH-21677)
...
Automerge-Triggered-By: @brettcannon
2020-07-29 11:36:46 -07:00
f6a16e8a82
Remove incorrect mention of method.__class__ in descriptor docs (GH-21665)
2020-07-28 16:56:26 -07:00
34cd3e9f6a
Fix `List_Append` description, list is extracted at TOS1[-i] (GH-21465)
2020-07-29 00:51:33 +08:00
5e3826785d
bpo-41328: Replace mention of Hudson CI with Travis CI and AppVeyor (GH-21653)
2020-07-28 07:48:32 -07:00
13efaec2e0
bpo-41045: Document debug feature of f-strings ('=') (GH-21509)
...
Co-Authored-By: Rishi <rishi93dev@gmail.com>
Automerge-Triggered-By: @gvanrossum
2020-07-27 15:31:02 -07:00
72cabb2aa6
bpo-40939: Use the new grammar for the grammar specification documentation (GH-19969)
...
(We censor the heck out of actions and some other stuff using a custom "highlighter".)
Co-authored-by: Guido van Rossum <guido@python.org>
2020-07-27 11:20:36 -07:00
508ed2d912
Delete remaining references to Grammar/Grammar from docs ( #21624 )
...
(Ironically, the file itself remains, see https://github.com/we-like-parsers/cpython/issues/135 .)
2020-07-26 08:27:52 -07:00
f117cef25b
bpo-39868: Add documentation for Assignment Expressions (walrus, PEP 572) ( #18851 )
2020-07-25 16:33:48 -07:00
0028c14073
bpo-41314: fixed annotations __future__ version (GH-21616)
...
PEP 563 was updated to change the release where `from __future__ import annotations` becomes the default (and only) behavior from 4.0 to 3.10. Update `__future__.py` and its docs to reflect this.
2020-07-25 14:42:49 -07:00
daff39070e
bpo-38731: Add --quiet option to py_compile CLI (GH-17134)
2020-07-25 22:58:45 +03:00
b9f6ac9d46
Stick with the phrase "default parameter value" (GH-21590)
2020-07-22 20:58:19 -03:00
5241e189e7
bpo-41283: Fix mismatched argument name for imghdr.what (GH-21501)
2020-07-20 21:22:01 -03:00
12f433411b
bpo-41334: Convert constructors of str, bytes and bytearray to Argument Clinic (GH-21535)
2020-07-20 15:53:55 +03:00
Serhiy Storchaka
Ethan Furman
Pablo Galindo
Andre Delfino
Patrick Reader
Tim Burke
Mandeep
Neeraj Samtani
Zackery Spytz
abdo
Raymond Hettinger
Emmanuel Arias
Sergey Fedoseev
Norbert Cyran
Stargirl Flowers
Benjamin Peterson
Mark Roseman
Bar Harel
Vinay Sajip
Hai Shi
Erlend Egeberg Aasland
johnthagen
Mario Šaško
Todd
Victor Stinner
Ned Deily
Roger Iyengar
SarahPythonista
Petr Viktorin
Mason
MingZhe Hu
wyz23x2
Mathieu Dupuy
Sydney Pemberton
Denis Ovsienko
Irit Katriel
Rishav Kundu
Facundo Batista
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)
Christopher Yeh
Ram Rachum
Edward K. Ream
Filipe Laíns
Stefan Krah
Jiajie Zhong
Yaroslav Pankovych
Benjamin Kane
Inada Naoki
pxinwr
Hans Petter Jansson
Ankit Chandawala
Nathan M
Luciano Ramalho
Sebastien Williams-Wynn
Yonatan Goldschmidt
Xiang Zhang
Dmytro Litvinov
amaajemyfren
Guido van Rossum
Shankar Jha
YoSTEALTH
Gregory Schevchenko
Ammar Askar