Miss Islington (bot)
7149b21c2e
sorting howto: Add clarification on < using __lt__ (GH-92010)
...
(cherry picked from commit 53ca774497
2022-04-29 15:25:31 -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
Ezio Melotti
4120bbae49
[3.10] gh-91888: add a :gh: role to the documentation (GH-91889) ( #91934 )
...
* gh-91888: Add a :gh: role to the documentation (GH-91889).
* [3.10] gh-91888: add a `:gh:` role to the documentation (GH-91889)
* Add a new :gh:`...` role for GitHub issues.
* Fix a GitHub id to use the :gh: role.
* Add Misc/NEWS entry.
* Refactoring and rephrasing.
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.
(cherry picked from commit f7641a2ffe
2022-04-26 02:51:28 +02:00
Ezio Melotti
dc31334ab1
[3.10] Update Sphinx bpo role to use redirect URI. ( #91890 )
...
* Update Sphinx bpo role to use redirect URI. (GH-32342)
* [3.10] Update Sphinx bpo role to use redirect URI. (GH-32342).
(cherry picked from commit 08cfe07950
2022-04-24 23:07: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
Oleg Iarygin
e7e8a9fa4f
[3.10] gh-91118: Fix docstrings that do not honor --without-doc-strings (GH-31769) ( #91662 )
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a573cb2fec
2022-04-19 13:01:09 -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)
531f66ad62
gh-89885: Improve import example in language reference (GH-91523)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit d5a69571f5
2022-04-17 14:34:41 -07:00
Miss Islington (bot)
e5636f3a0e
gh-91541: Fix error in example in modules tutorial (GH-91634)
...
(cherry picked from commit efbc668183
2022-04-17 14:30:57 -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)
2e1f969333
Add link to documentation translation list (GH-91560) ( #91589 )
...
(cherry picked from commit c4e8a93eb3
2022-04-16 04:16:05 +02: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)
35fef27110
Add redirects to Misc/NEWS bpo links (GH-91454) (GH-91535)
...
(cherry picked from commit 17dbb6bc10
2022-04-14 17:02:03 +02: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)
b4abef2295
c-api docs: There are five fields, not four (GH-32379)
...
(cherry picked from commit 4c92427fb8
2022-04-07 07:27: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
Miss Islington (bot)
08bd308dd2
pkgutil docs: Link sys constants, add backticks (GH-32356)
...
Co-authored-by: Éric <merwok@netwok.org>
(cherry picked from commit 63bd72448a
2022-04-06 18:12:34 -07:00
Miss Islington (bot)
55abb0ef25
stdtypes docs: fix typo (GH-32349) (GH-32370)
...
(cherry picked from commit b33c4564ac
2022-04-06 17:50:04 -07:00
Ken Jin
80af26d25a
[3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374)
...
* Use double backticks to appease rstlint
* Update susp-ignored.csv
2022-04-07 02:00:26 +08:00
Miss Islington (bot)
3856b4995e
bpo-47235: Note where a typo is intentional in code. (GH-32348)
...
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text. Hopefully a comment
on the line itself makes it more obvious?
Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code. But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
(cherry picked from commit ac1fb07b6e
2022-04-06 08:30:01 -07:00
Miss Islington (bot)
857cf55cbd
bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)
...
It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920c5b
2022-04-04 20:16:16 -07:00
Miss Islington (bot)
97151e1e3a
crypt docs: Fix references to methods attr (GH-26806)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit cae0f5d3da
2022-04-04 20:09:45 -07:00
Miss Islington (bot)
d95e072c41
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 43571a3eea
2022-04-04 20:08:17 -07:00
Miss Islington (bot)
f4e711bb49
bpo-45790: List macros in same order in which fields are described (GH-29529)
...
Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b275267aa7
2022-04-04 19:57:22 -07:00
Miss Islington (bot)
f502dadb33
bpo-47007: [doc] str special method lookup (GH-31863)
...
Clarify the `str()` docs to point out that `object.__str__()`
follows special method lookup.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit bb86d1d9fb
2022-04-04 19:56:29 -07:00
Miss Islington (bot)
3fa800d7a7
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
...
Co-authored-by: Andrew Kuchling <amk@amk.ca>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a74892cb21
2022-04-04 19:30:06 -07:00
Miss Islington (bot)
29ffac2d39
Demonstrate py --list in the quickstart section of the Windows doc page (GH-29383)
...
(cherry picked from commit 1ecfe3d5ae
2022-04-04 08:58:44 -07:00
Miss Islington (bot)
a331d0f627
Follow PEP-8 guidelines in tutorial for standard library (GH-26127)
...
(cherry picked from commit 6db2db91b9
2022-04-03 15:49:52 -07:00
Miss Islington (bot)
a5c90784be
Language reference: Remove duplicated text about iterable unpacking (GH-25212)
...
(cherry picked from commit 4f5d56f8f3
2022-04-02 20:05:11 -07:00
Miss Islington (bot)
ce6af314ca
bpo-24563: Link encoding names to encoding declarations (GH-32274)
...
(cherry picked from commit 01be5d6446
2022-04-02 17:40:55 -07:00
Jelle Zijlstra
11f5fd1135
[3.10] More minor fixes to C API docs (GH-31525) (GH-32258)
...
* wording fixes in type.rst
* grammar and punctuation in sys.rst
* set: grammar fixes
* structures: capitalization fix
* grammar fixes for sequence
* objects: point to Py_TYPE instead of direct object access
* numbers: add more explicit Python equivalences
* method: add missing period
* memory: grammar fix
* mapping: grammar fixes
* long: grammar fix
* iter: fix grammar for PyAIter_Check
* init: grammar fix.
(cherry picked from commit 897bc6f928
2022-04-02 16:00:51 -07:00
Jelle Zijlstra
a930062d25
[3.10] Document func parameter of locale.atof (GH-18183) (GH-32262)
...
The second parameter (named `func`) has been present since the `locale`
module was introduced in eef1d4e8b1208da6d508
2022-04-02 15:59:41 -07:00
Miss Islington (bot)
3031b86753
bpo-45584: Clarify math.trunc documentation (GH-29183)
...
While floor/ceil 's documentation are very precise, `truncate` was not explained. I actually had to search online to understand the difference between `truncate` and `floor` (admittedly, once I remembered that numbers are signed, and that floating numbers actually uses a bit for negation symbol instead of two complement, it became obvious)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit ebbdbbff5d
2022-04-02 15:30:59 -07:00
Miss Islington (bot)
8d9a75b206
os docs: fix typo (GH-28996)
...
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
(cherry picked from commit 1f80dcd244
2022-04-02 15:00:12 -07:00
Miss Islington (bot)
2d936a42ac
codecs docs: fix grammar mistake (GH-29462)
...
(cherry picked from commit ea56845744
2022-04-02 14:33:52 -07:00
Miss Islington (bot)
23c0200c43
bpo-45114: Use lstat() instead of stat() in stat docs example (GH-29845)
...
(cherry picked from commit c93a0ac697
2022-04-02 14:19:48 -07:00
