Mason
b260635b3d
Add missing word (GH-21936)
...
"data to lost" -> "data to be lost"
2020-08-27 02:49:14 +02:00
MingZhe Hu
8c58d2a216
bpo-41624: fix documentation of typing.Coroutine (GH-21952)
2020-08-27 02:42:37 +02:00
Andre Delfino
802726acf6
Document vars behavior when __dict__ is missing ( #21466 )
2020-08-21 19:29:34 -03:00
wyz23x2
7173fc84e6
bpo-41573: Update release versions in General FAQ (GH-21915)
2020-08-21 18:28:54 -04:00
Mathieu Dupuy
12695f4c6d
Doc: add a missing period (GH-21819)
2020-08-20 22:08:37 +02:00
Sydney Pemberton
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
Denis Ovsienko
0be7c216e1
Fix grammar in Doc/tutorial/controlflow.rst (GH-21885)
...
Automerge-Triggered-By: @csabella
2020-08-19 04:29:47 -07:00
Victor Stinner
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
Victor Stinner
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
Irit Katriel
fa5d725198
Fix typo in typing doc (GH-21879)
...
Automerge-Triggered-By: @gvanrossum
2020-08-14 16:01:36 -07:00
Victor Stinner
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
Rishav Kundu
e55de68be3
bpo-41410: Fix outdated info in mkstemp docs (GH-21701)
...
Automerge-Triggered-By: @ericvsmith
2020-08-13 18:33:14 -07:00
Facundo Batista
a3eae43aee
Fixed comment about pathlib.link_to: it was added in 3.8, not changed. ( #21851 )
2020-08-13 17:33:56 -03:00
Victor Stinner
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
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)
0eb9deb4a6
bpo-41066: Update the comparison section for os vs pathlib (GH-21261)
2020-08-13 21:52:04 +02:00
Victor Stinner
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
Victor Stinner
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
Victor Stinner
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
Victor Stinner
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
Victor Stinner
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
Christopher Yeh
0dfee33dfe
Fix typo (GH-21820)
2020-08-11 19:27:08 -03:00
Ram Rachum
76643c10ed
bpo-41475: Fix note in "What's new in 3.7" ( #21733 )
2020-08-11 18:33:25 +02:00
Petr Viktorin
af3a6a8cae
Add PEP 573 additions to What's New (GH-21374)
2020-08-11 18:15:57 +02:00
Edward K. Ream
e3c971ccfa
Add links to asttokens, leoAst, LibCST and parso to ast docs (GH-21773)
2020-08-11 07:07:49 -07:00
Victor Stinner
fabd7bb8e0
bpo-41521: Replace whitelist/blacklist with allowlist/denylist (GH-21822)
...
Automerge-Triggered-By: @tiran
2020-08-11 06:26:59 -07:00
Filipe Laíns
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
Stefan Krah
39042e00ab
bpo-41324 Add a minimal decimal capsule API ( #21519 )
2020-08-10 16:32:21 +02:00
Zackery Spytz
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
Jiajie Zhong
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
Yaroslav Pankovych
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
Benjamin Kane
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
Inada Naoki
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
pxinwr
3405e05428
bpo-41440: add os.cpu_count() support for VxWorks RTOS (GH-21685)
2020-08-07 14:21:52 +09:00
Inada Naoki
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
Hans Petter Jansson
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
Ankit Chandawala
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
Nathan M
ecaf949cc4
bpo-41424: Remove extra words in Tkinter-Packer documentation (GH-21707)
2020-08-02 22:13:03 -04:00
Luciano Ramalho
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
Sebastien Williams-Wynn
ba18c0b13b
bpo-41426 Fix grammar in curses.getmouse() documentation (GH-21677)
...
Automerge-Triggered-By: @brettcannon
2020-07-29 11:36:46 -07:00
Yonatan Goldschmidt
f6a16e8a82
Remove incorrect mention of method.__class__ in descriptor docs (GH-21665)
2020-07-28 16:56:26 -07:00
Xiang Zhang
34cd3e9f6a
Fix `List_Append` description, list is extracted at TOS1[-i] (GH-21465)
2020-07-29 00:51:33 +08:00
Dmytro Litvinov
5e3826785d
bpo-41328: Replace mention of Hudson CI with Travis CI and AppVeyor (GH-21653)
2020-07-28 07:48:32 -07:00
amaajemyfren
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
Pablo Galindo
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
Guido van Rossum
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
Shankar Jha
f117cef25b
bpo-39868: Add documentation for Assignment Expressions (walrus, PEP 572) ( #18851 )
2020-07-25 16:33:48 -07:00
YoSTEALTH
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
Gregory Schevchenko
daff39070e
bpo-38731: Add --quiet option to py_compile CLI (GH-17134)
2020-07-25 22:58:45 +03:00
Andre Delfino
b9f6ac9d46
Stick with the phrase "default parameter value" (GH-21590)
2020-07-22 20:58:19 -03:00
Ammar Askar
5241e189e7
bpo-41283: Fix mismatched argument name for imghdr.what (GH-21501)
2020-07-20 21:22:01 -03:00