Norbert Cyran
c75330605d
bpo-41672: Fix type mismatches in imaplib docs (GH-22207)
2020-09-12 16:58:56 +09:00
Stargirl Flowers
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
Benjamin Peterson
3304cbd990
Doc: Fix alphabetical ordering of removeprefix/suffix. (GH-22194)
2020-09-11 08:59:02 +09:00
Mark Roseman
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
Bar Harel
1e874d5bec
Update logging documentation to tidy up formatting (GH-22173)
2020-09-10 11:50:23 +01:00
Andre Delfino
788b79fa7b
[doc] Remove superfluous comment about equal in f-strings (GH-22006)
...
Automerge-Triggered-By: @kushaldas
2020-09-09 23:33:13 -07:00
Andre Delfino
7a797a3967
Add missing colon to IDLE doc markup (GH-22007)
2020-09-09 18:17:14 -04:00
Vinay Sajip
76553e5d2e
Add minor clarification in logging documentation. (GH-22167)
2020-09-09 11:21:22 +01:00
Hai Shi
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
Andre Delfino
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
Erlend Egeberg Aasland
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
Andre Delfino
5bfd60fc2b
[doc] Add link to Generic in typing (GH-22125)
2020-09-06 22:29:38 -07:00
Zackery Spytz
5371a464ce
closes bpo-41723: Fix an error in the py_compile documentation. (GH-22110)
2020-09-05 22:39:23 -05:00
Andre Delfino
2623868ede
[doc] Fix padding in some typing definitions (GH-22114)
...
Automerge-Triggered-By: @gvanrossum
2020-09-05 16:40:25 -07:00
johnthagen
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
Zackery Spytz
51b84f8e96
bpo-38585: Remove references to defusedexpat (GH-22095)
...
defusedexpat is not maintained.
2020-09-04 13:57:48 -07:00
Serhiy Storchaka
306cfb3a37
bpo-40486: Specify what happens if directory content change diring iteration (GH-22025)
2020-09-04 21:19:30 +03:00
Vinay Sajip
cdbff3527c
[doc] Update documentation on logging optimization. (GH-22075)
2020-09-03 19:44:12 +01:00
Mario Šaško
8516060076
[doc] Fix a typo in the graphlib docs ( #22030 )
2020-09-03 11:00:10 +01:00
Todd
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
Pablo Galindo
5a4a963a6c
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047)
2020-09-02 15:29:38 +01:00
Victor Stinner
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
Victor Stinner
c0d5c131d9
bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)
2020-09-02 12:29:31 +02:00
Andre Delfino
1d25f5bf7b
Remove reference to Boa Constructor. (GH-22012)
2020-09-01 22:22:55 -05:00
Andre Delfino
dea82b6731
[doc] Remove references to PyChecker. (GH-22011)
2020-09-01 22:21:12 -05:00
Benjamin Peterson
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
Andre Delfino
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
Ned Deily
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
Andre Delfino
3584d4b64a
[doc] Document VIRTUAL_ENV environment variable (GH-21970)
2020-09-01 07:07:29 +01:00
Andre Delfino
c3a651ad25
[doc] Fix markup in logging (GH-22008)
2020-08-30 21:36:58 +01:00
Roger Iyengar
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
SarahPythonista
8784d3300e
Fix error in argparse documentation example (GH-17399)
...
Automerge-Triggered-By: @rhettinger
2020-08-28 11:47:58 -07:00
Petr Viktorin
d9a966ae08
bpo-38787: Clarify docs for PyType_GetModule and warn against common mistake (GH-20215)
2020-08-27 15:36:48 +02:00
Zackery Spytz
398575c210
bpo-41634: Fix a typo in the curses documentation (GH-21958)
2020-08-27 16:58:16 +05:30
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
