C.A.M. Gerlach
ea19c28512
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) ( #98371 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518
2022-10-18 01:49:38 +02:00
Miss Islington (bot)
211b8193ca
GH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (GH-98336)
...
(cherry picked from commit ae19217867
2022-10-16 12:41:41 -07:00
Vinay Sajip
79c0adeb1d
[3.11] [doc] Update logging cookbook with an example of custom handli… (GH-98296)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-15 21:51:58 +01:00
Miss Islington (bot)
316590116a
gh-65046: Link to logging cookbook from asyncio docs (GH-98207)
...
(cherry picked from commit c39a0c3354
2022-10-11 21:51:13 -07:00
Miss Islington (bot)
6554598236
Minor edits to the Descriptor HowTo Guide (GH-24901)
...
Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
(cherry picked from commit 2d2e01aa4c
2022-10-08 19:03:25 -07:00
Miss Islington (bot)
27a7fe319a
[3.11] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) ( #97976 )
...
Also, disable using invalid sphinx-lint 0.6.2.
(cherry picked from commit f612565bd3
2022-10-06 10:49:29 -07:00
Miss Islington (bot)
011260bca0
[3.11] [docs] Update logging cookbook with recipe for using a logger like an output… (GH-97730) (GH-97735)
2022-10-02 17:44:42 +01:00
Miss Islington (bot)
73557d5bd2
[3.11] gh-65046: Add note about logging from async code. (GH-97602) (GH-97608)
2022-09-28 05:32:01 +01:00
Miss Islington (bot)
4d1de87042
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
...
(cherry picked from commit db39050396
2022-09-25 01:20:45 -07:00
Miss Islington (bot)
b76c43a55a
[3.11] gh-77116: Add SMTP buffering example to logging cookbook. (GH-96324) (GH-96326)
2022-08-27 12:15:53 +01:00
Miss Islington (bot)
d6990681b6
GH-95822: Need _PyType_Lookup() in descriptor howto code equivalent. (GH-95967) ( #96099 )
2022-08-19 00:18:44 -05:00
Miss Islington (bot)
c521c5cdc3
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
...
It updates links which redirect to HTTPS with different authority or
path.
(cherry picked from commit d0d0154443
2022-08-04 06:15:11 -07:00
Serhiy Storchaka
d8df7e0207
[3.11] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95643)
...
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.
This change does not affect Python examples..
(cherry picked from commit f79547a429
2022-08-04 11:45:03 +03:00
Miss Islington (bot)
a6c4ca9b7c
[3.11] [doc] Update cookbook example and add information about queue types. (GH-94854) (GH-94871)
...
(cherry picked from commit dc54193095
2022-07-15 08:19:02 +01:00
Miss Islington (bot)
7a3dae06eb
Docs: Convert PEP 630 (Isolating Extension Modules) to a HOWTO (GH-94489) (GH-94566)
...
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit e6ec6f5b50
2022-07-05 17:20:03 +02:00
Miss Islington (bot)
77bf973930
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5
2022-07-05 14:30:19 +02:00
Vinay Sajip
8fe0b1d8fa
[3.11] Update logging documentation: change cross-reference and add webapp r… (GH-94541)
2022-07-04 09:09:40 +01:00
Miss Islington (bot)
8b77681469
bpo-39971: Change examples to be runnable (GH-32172)
...
(cherry picked from commit c57a1c76d7
2022-06-25 13:59:43 -07:00
Miss Islington (bot)
63e127f33d
gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)
...
(cherry picked from commit f62ff97f31
2022-06-21 21:06:05 +02:00
Miss Islington (bot)
7bfeb8a606
[3.11] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93647)
2022-06-09 17:28:34 +01:00
Miss Islington (bot)
92f8786ef8
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93638)
...
(cherry picked from commit a5ba0f4ebc
2022-06-09 16:15:33 +02:00
Miss Islington (bot)
cea65730a7
gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93151)
...
(cherry picked from commit 2176898308
2022-05-23 20:45:03 +01:00
Miss Islington (bot)
0c1795bd33
Document Py_ssize_t. (GH-92512)
...
It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But
there's 8182 errors left.
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 664aa94b57
2022-05-13 06:32:05 -07:00
Raymond Hettinger
ebaf0945f9
GH-89519: Deprecate classmethod descriptor chaining ( #92379 )
2022-05-06 02:57:53 -05:00
Carl Meyer
7d7a378c1a
Fix typo in Sorting howto ( #92280 )
...
The phrase is usually "odds and ends," not "odd and ends."
2022-05-03 21:38:29 -06:00
slateny
53ca774497
sorting howto: Add clarification on < using __lt__ ( #92010 )
2022-04-29 16:08:07 -06:00
Inada Naoki
1317b70f89
gh-91156: Use locale.getencoding() instead of getpreferredencoding (GH-91732)
...
Co-authored-by: Victor Stinner <vstinner@python.org>
2022-04-22 10:39:24 +09:00
Mathieu Dupuy
f82f9ce323
Remove python2 support in logging cookbook example. (GH-32362)
2022-04-06 17:57:54 +01:00
Mike cm
43571a3eea
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-04 19:46:54 -07:00
Dave Goncalves
8be7c2bc5a
bpo-14911: Corrected generator.throw() documentation (GH-32207)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2022-03-31 16:56:48 +03:00
Serhiy Storchaka
c6cd3cc93c
bpo-47081: Replace "qualifiers" with "quantifiers" in the re module documentation (GH-32028)
...
It is a more commonly used term.
2022-03-22 11:44:47 +02:00
Yuxin Wu
fc44b8136f
[doc] Add a note in howto/logging.rst about "do not log to root logger in libraries" (GH-31271)
2022-02-26 18:29:51 +00:00
Raymond Hettinger
12a2e41e8a
Improve discussion about how __getattr__ is invoked. (GH-31435)
2022-02-19 23:02:30 -06:00
Alex-Blade
0cb765b2ce
bpo-46730: Add more info to @property AttributeError messages (GH-31311)
...
On `obj.read_only_property = x`, raise `AttributeError: property 'read_only_property' of 'A' object has no setter`.
2022-02-16 02:07:34 -05:00
Petr Viktorin
204946986f
bpo-46613: Add PyType_GetModuleByDef to the public API (GH-31081)
...
* Make PyType_GetModuleByDef public (remove underscore)
Co-authored-by: Victor Stinner <vstinner@python.org>
2022-02-11 17:22:11 +01:00
Manish Kumar ⛄
ba650af7d6
Optimize images by IMGbot (GH-21348)
...
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
2022-02-04 15:49:43 +09:00
Julien Palard
bcafab849e
[doc]: Spotted errors while working on rstlint. (GH-30879)
...
Also ignored some `make suspicious` false positives while assuring
true positives were properly seen by rstlint.
2022-01-27 08:57:43 +01:00
Piotr Fusik
d05a66339b
no-issue: Fix documentation typos. (GH-30576)
2022-01-20 17:17:15 +09:00
Kumar Aditya
83d544b929
bpo-40066: [Enum] skip failing doc test (GH-30637)
2022-01-17 07:18:13 -08:00
Victor Stinner
42a64c03ec
Revert "bpo-40066: [Enum] update str() and format() output (GH-30582)" (GH-30632)
...
This reverts commit acf7403f9b
2022-01-17 13:58:40 +01:00
Ethan Furman
acf7403f9b
bpo-40066: [Enum] update str() and format() output (GH-30582)
...
Undo rejected PEP-663 changes:
- restore `repr()` to its 3.10 status
- restore `str()` to its 3.10 status
New changes:
- `IntEnum` and `IntFlag` now leave `__str__` as the original `int.__str__` so that str() and format() return the same result
- zero-valued flags without a name have a slightly changed repr(), e.g. `repr(Color(0)) == '<Color: 0>'`
- update `dir()` for mixed-in types to return all the methods and attributes of the mixed-in type
- added `_numeric_repr_` to `Flag` to control display of unnamed values
- enums without doc strings have a more comprehensive doc string added
- `ReprEnum` added -- inheriting from this makes it so only `__repr__` is replaced, not `__str__` nor `__format__`; `IntEnum`, `IntFlag`, and `StrEnum` all inherit from `ReprEnum`
2022-01-15 22:41:43 -08:00
Nikita Sobolev
6223cbf86a
bpo-45331: [Enum] add rule to docs that mixin type must be subclassable (GH-30521)
2022-01-10 15:42:45 -08:00
Alex Waygood
b2afdc95cc
bpo-45535: Improve output of Enum `dir()` (GH-29316)
...
Modify the ``EnumType.__dir__()`` and ``Enum.__dir__()`` to ensure
that user-defined methods and methods inherited from mixin classes always
show up in the output of `help()`. This change also makes it easier for
IDEs to provide auto-completion.
2021-12-02 08:49:52 -08:00
Vinay Sajip
39b60ceae8
[Doc] Add info to logging cookbook about running logging socket listeners i… (GH-29838)
2021-11-29 13:06:52 +00:00
Guido van Rossum
94daf39b2f
Fix markup buglet in Doc/howto/annotations.rst ( #29802 )
2021-11-26 14:10:01 -08:00
Raymond Hettinger
e34809e1c2
bpo-19072: Classmethod can wrap other classmethod like descriptors (GH-29634)
...
staticmethod() also became callable in Python 3.10.
See: b83861f02
2021-11-19 19:43:49 +01:00
Ethan Furman
cb755dba7a
bpo-45740: [Enum] add versionadded markers to docs (GH-29443)
...
[Enum] add versionadded markers to docs
2021-11-06 10:16:43 -07:00
Ethan Furman
7c4d96103c
bpo-44174: [Enum] add reference to name mangling (GH-29116)
2021-10-20 20:32:11 -07:00
Hugo van Kemenade
d89fb9a5a6
bpo-45320: Remove long-deprecated inspect methods (GH-28618)
2021-10-20 20:48:55 +02:00
DonnaDia
7af95a1e80
bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity (GH-27989)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-06 16:51:55 +02:00
