Miss Islington (bot)
cd11068712
bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)
...
* Some handlers were wrongly described as text-encoding only, but actually they can also be used in text-decoding.
* Add more description to each handler.
* Add two REPL examples.
* Add indexes for Error Handler's name.
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 5bc2390229
2022-05-08 20:16:26 -07:00
Miss Islington (bot)
158579654d
bpo-39229: fix formatting in library/functions.rst (GH-17857)
...
Missing reference of auditing event presents error when building translated documentation
(cherry picked from commit f298ba1f27
2022-05-08 16:39:09 -07:00
Miss Islington (bot)
6679fdf4f0
pdb docs: workaround for double semicolon in strings (GH-17011)
...
see https://github.com/gotcha/ipdb/issues/172
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 2888b1107f
2022-05-08 16:38:47 -07:00
Miss Islington (bot)
1dbf69979f
gh-80856: doc: reveal doctest directives (GH-92318)
...
* Doc: Reveal doctest directives.
* Fix whitespace.
Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 7b024e3a3f
2022-05-08 09:32:20 -07:00
Miss Islington (bot)
15cb6e8b8b
gh-92417: logging docs: Remove warning that only applies to Python <3.2 (GH-92425)
...
(cherry picked from commit 318c4e91ef
2022-05-08 09:03:09 -07:00
Miss Islington (bot)
e363034752
[3.10] gh-92417: asyncio docs: asyncio.run() is available on all supported Python versions (GH-92419) (GH-92463)
...
(cherry picked from commit f4e317b304
2022-05-08 08:30:43 -07:00
Miss Islington (bot)
2164b5bad7
[3.10] gh-92417: json docs: dict is ordered on all supported Python versions (GH-92422) (GH-92465)
...
(cherry picked from commit bc098cfdb7
2022-05-08 08:30:18 -07:00
Miss Islington (bot)
45ed69b200
[3.10] gh-92417: doctest docs: remove references to Python <3.6 (GH-92420) (GH-92468)
...
(cherry picked from commit 5639ea1ef9
2022-05-08 08:29:50 -07:00
Miss Islington (bot)
a7d869a2ea
[3.10] gh-77630: Change Charset to charset (GH-92439) (GH-92476)
...
(cherry picked from commit 8f29318079
2022-05-08 08:28:06 -07:00
Miss Islington (bot)
8c42fefa39
[3.10] gh-92417: stdtypes docs: delete discussion of Python 2 differences (GH-92423) (GH-92473)
...
Given that 2.7 has now been end-of-life for two and a half years,
I don't think we need such a detailed explanation here anymore of
the differences between Python 2 and Python 3.
(cherry picked from commit 8efda1e7c6
2022-05-08 08:26:06 -07:00
Miss Islington (bot)
80ce70110b
gh-92417: typing docs: from __future__ import annotations can be used in all supported Python versions (GH-92418)
...
(cherry picked from commit e5b4bd4d60
2022-05-08 08:04:18 -07:00
Miss Islington (bot)
bb2dcf1c79
gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224)
...
(cherry picked from commit d1b2e989be
2022-05-04 17:30:54 -07:00
Jelle Zijlstra
31d9a88ca8
[3.10] Improve the typing docs (GH-92264) ( #92270 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 27e3665715
2022-05-03 16:41:39 -06:00
Miss Islington (bot)
5f40cb85c2
bpo-46586: Fix more erroneous doc links to builtins (GH-31429)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
(cherry picked from commit cc6ae4f483
2022-05-02 15:51:33 -07:00
Miss Islington (bot)
f44e629a57
bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612)
...
(cherry picked from commit 32e4f450af
2022-05-02 15:44:07 -07:00
Miss Islington (bot)
d851f37b88
importlib docs: Update importlib.abc hierarchy (GH-31113)
...
Fixed some inconsistencies in the text about relationships
(cherry picked from commit 5f45a9d3c3
2022-05-02 13:48:59 -07:00
Thaddeus1499
c8ab1633fc
[3.10] bpo-43504: Remove effbot urls (GH-26308) ( #92161 )
...
* [3.10] Remove effbot urls (GH-26308).
(cherry picked from commit e9f66aedf4
2022-05-02 12:21:51 -06:00
Miss Islington (bot)
bab4d0bb16
gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)
...
(cherry picked from commit 4b297a9ffd
2022-05-02 10:34:59 -07:00
Miss Islington (bot)
0e9927b6b0
gh-92082: contextlib docs: Change aclosing from a class to a function for consistency (GH-92155)
...
Signed-off-by: prwatson <prwatson@redhat.com>
(cherry picked from commit 958f21c5cd
2022-05-02 09:37:10 -07:00
Miss Islington (bot)
446cc03730
gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered sentence (GH-91614)
...
(cherry picked from commit b9ab6cea08
2022-05-02 08:35:37 -07:00
Miss Islington (bot)
9941640041
asyncio.subprocess: Fix a typo in doc (GH-92030)
...
Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance
(cherry picked from commit bb857a96ef
2022-05-02 08:18:01 -07:00
Miss Islington (bot)
9ce39cc9f2
gh-85133: os docs: Add that getenv uses os.environ (GH-91874)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b25352a5c0
2022-05-02 07:58:09 -07:00
Miss Islington (bot)
bba721d0fa
gh-84714: Add behavior if dst file exists (GH-91867)
...
(cherry picked from commit 9166ace805
2022-05-02 07:51:07 -07:00
Miss Islington (bot)
e7de543219
typing docs: Add example for async functions (GH-20386)
...
Fixes python/typingGH-424
(cherry picked from commit 9588f880a2
2022-04-30 21:55:58 -07:00
Miss Islington (bot)
a48d31f204
gh-81488: Add recursive wording for issubclass docs (GH-92087)
...
(cherry picked from commit 1066ecb970
2022-04-30 21:21:51 -07:00
Miss Islington (bot)
31e35bef22
gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)
...
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.
On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246782
2022-04-30 21:03:11 -07:00
Miss Islington (bot)
335aae1950
gh-87801: Add run() to subprocess.CalledProcessError description (GH-91628)
...
(cherry picked from commit 567be058b4
2022-04-30 14:51:45 -07:00
Miss Islington (bot)
cfcda0acf2
gh-87192: Update wording for fcntl 'Changed in' (GH-91658)
...
(cherry picked from commit d7eb1ffbe8
2022-04-30 14:44:08 -07:00
Miss Islington (bot)
5ed9556cfb
gh-85864: io docs: Add missing position-only parameters (GH-91950)
...
(cherry picked from commit 3a8e2b6e65
2022-04-30 08:39:29 -07:00
Miss Islington (bot)
e25799d27d
Add note that headers added via urllib.request.add_header are added to redirected requests (GH-30708) ( #92004 )
...
(cherry picked from commit f348154c8f
2022-04-27 16:26:42 -06:00
Miss Islington (bot)
86e4bdaf49
gh-84459: Make wording more specific for Path.replace (GH-91853)
...
GH-84459
(cherry picked from commit 161dff7e10
2022-04-27 15:18:06 -07:00
Victor Stinner
a36d97e3f1
gh-68966: Document mailcap deprecation in Python 3.11 ( #91971 )
...
(cherry picked from commit 80de0273c0
2022-04-27 11:39:51 +02:00
Miss Islington (bot)
0482ed7d07
gh-85864: Mark positional-only args in io docs (GH-91683)
...
(cherry picked from commit a3f2cf3ced
2022-04-22 17:48:13 -07:00
Miss Islington (bot)
7ade77709b
gh-91547: Remove "Undocumented modules" page (GH-91682)
...
(cherry picked from commit 254aaa7981
2022-04-22 16:33:46 -07:00
Miss Islington (bot)
886b22c4c3
bpo-23747: Enhance platform doc, document default behavior (GH-31462)
...
(cherry picked from commit ad3ca17ff5
2022-04-20 09:41:12 -07:00
Miss Islington (bot)
88bbc5dd7a
bpo-30718: Add information about text buffering (GH-32351)
...
(cherry picked from commit 5101d97d0b
2022-04-20 02:00:43 -07:00
Miss Islington (bot)
8299e24d4c
Add link to sys.path in os lib (GH-91679)
...
(cherry picked from commit 692aea6f38
2022-04-19 21:17:34 -07:00
Miss Islington (bot)
f92aa4fde1
Fix awkward sentence in signal docs (GH-91508)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 326ae71f1d
2022-04-19 18:38:15 -07:00
Miss Islington (bot)
e08d32381d
gh-87497: Document that urllib.request sends headers in camel case (GH-24661) ( #91517 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 325d6f5035
2022-04-19 18:20:03 -07:00
Miss Islington (bot)
b865a661e3
Doc: Fix link formatting typo (GH-91659)
...
(cherry picked from commit 6a7a8a740e
2022-04-19 02:33:44 -07:00
Miss Islington (bot)
0897a0bf9c
Remove duplicate explanation (GH-91534)
...
(cherry picked from commit 0e6dca0193
2022-04-17 21:44:58 -07:00
Miss Islington (bot)
2bcfe20d92
gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
...
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a229
2022-04-17 14:29:21 -07:00
Miss Islington (bot)
f5542ecf6d
gh-82849: revise intro to os.path.rst (GH-32232)
...
* revise the first paragraph of docs for os.path
* add a mention of `os.PathLike` protocol
* remove warnings rendered irrelevant by :pep:`383` and :pep:`529`
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 468314cc8b
2022-04-15 21:38:11 -07:00
Miss Islington (bot)
289f27d06b
gh-88513: clarify shutil.copytree's dirs_exist_ok arg (GH-91434) (GH-91464)
...
* add a paragraph to document this kwarg in detail
* update docstring in the source accordingly
(cherry picked from commit f33e2c87a8
2022-04-15 15:55:13 +02:00
Miss Islington (bot)
de7b756521
gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
...
Noticed while reviewing GH-30729.
(cherry picked from commit f1e989b045
2022-04-14 18:23:20 -07:00
Miss Islington (bot)
52ce75fc1e
gh-90879: Fix missing parameter for put_nowait() (GH-91514)
...
(cherry picked from commit 0fc3517cf4
2022-04-14 02:18:31 -07:00
Miss Islington (bot)
89192c46da
pickle docs: Fix typos and improve wording (GH-24776) (GH-32395)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 1d0f08fa46
2022-04-07 18:56:17 -07:00
Miss Islington (bot)
877fd622e8
ssl docs: Fix typo (GH-32336)
...
(cherry picked from commit 9ee2d3a939
2022-04-07 09:51:40 -07:00
Miss Islington (bot)
ccac6312b9
doc: Link to string.capwords from str.title (GH-20913)
...
Since `title()` mentions its own short-comings, it should also mention the library function which does not possess them.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b786d9ec52
2022-04-06 18:52:51 -07:00
Miss Islington (bot)
b217ba7371
ssl docs: Fix typo (GH-32314)
...
(cherry picked from commit 1da9c38fd3
2022-04-06 18:13:46 -07:00
