97e1e43af1
[3.11] [doc] logging.rst - Change link to point directly to the Google Group. (GH-93390) (GH-104318)
...
(cherry picked from commit e6e81602f4
2023-05-09 15:31:00 +01:00
a635d63860
[3.11] gh-64658: Expand Argument Clinic return converter docs ( #104175 ) ( #104198 )
2023-05-05 13:46:23 +02:00
365e0772c9
[3.11] gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules (GH-103457) ( #104124 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 23:20:50 -06:00
5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) ( #104088 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001 )
2023-05-02 14:50:16 +03:00
9f4364355e
[3.11] gh-101100: Fix Sphinx warnings in `argparse` module ( #103289 ) ( #103803 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 22:15:04 +00:00
e40db6e6ae
[3.11] Descriptor HowTo: Update to include attributes added in Python 3.10 (GH-103666) ( #103680 )
...
Descriptor HowTo: Update to include attributes added in Python 3.10 (GH-103666)
(cherry picked from commit 7b134d3e71
2023-04-24 15:05:14 +05:30
8642fdce8c
[3.11] GH-103484: Fix broken links reported by linkcheck (GH-103608) ( #103683 )
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Fix broken links reported by linkcheck (#103608 )
2023-04-23 23:26:15 +03:00
3b929a7b32
[3.11] gh-103479: [Enum] require __new__ to be considered a data type (GH-103495) (GH-103514)
...
a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type; an __init__ method is not enough (restores pre-3.11 behavior for non-dataclasses).
(cherry picked from commit a6f95941a3
2023-04-13 12:04:06 -07:00
58e330ac9c
[3.11] gh-93910: [Enum] remove member.member deprecation (GH-103236) (GH-103299)
...
i.e. Color.RED.BLUE is now officially supported..
(cherry picked from commit 4ec8dd10bd
2023-04-05 21:29:14 -07:00
cf72cc25f6
gh-98298, gh-74730: [Enum] update docs (GH-103163)
...
fix FlagBoundary statements
add warning about reloading modules and enum identity
(cherry picked from commit 5ffc1e5a21
2023-04-03 15:27:33 -07:00
d189e2db0b
[3.11] gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635) (GH-103106)
...
(cherry picked from commit d835b3f05d
2023-03-29 10:04:53 +01:00
2c4fc87ac1
[3.11] [doc] Improve grammar/fix missing word (GH-102060) (GH-102277)
...
[doc] Improve grammar/fix missing word (GH-102060)
(cherry picked from commit 6daf42b28e
2023-02-26 18:58:55 +05:30
5e498072dc
[3.11] gh-101440: fix json snippet error in logging-cookbook.rst (GH-101439) (GH-101463)
...
(cherry picked from commit 20c11f2e60
2023-01-31 07:51:48 -08:00
5e1c4ac85e
[3.11] Provided better example for logging cookbook (GH-101164) (GH-101184)
...
Co-authored-by: Vladimir Malinovskii <galqiwi@galqiwi.ru>
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-20 17:43:08 +00:00
a7f9afdd46
[3.11] gh-100916: Convert argument to appropriate type (GH-100917) (GH-100918)
...
Co-authored-by: Yao-Ching Huang <tom4996131207@gmail.com>
2023-01-10 10:38:57 +00:00
44b664e057
gh-99535: Add test for inheritance of annotations and update documentation (GH-99990)
...
(cherry picked from commit f5b7b19bf1
2022-12-24 12:31:10 -08:00
944ac46b88
[3.11] gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395) (GH-99415)
...
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
(cherry picked from commit 73a921b070
2022-11-12 10:43:32 -08:00
cf5dbb47a2
[Enum] Typo: fix DuplicateFreeEnum example docs (GH-99265)
...
(cherry picked from commit b3bd69c1bf
2022-11-08 16:51:04 -08:00
8b4d5b1047
argparse howto: Use f-string in preference to "...".format() (GH-98883)
...
(cherry picked from commit 1fd20d0b57
2022-11-02 19:17:33 -07:00
67f63b82b8
[3.11] [doc] Update cookbook example for socket-based logging in a production sett… (GH-98922) (GH-98980)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-01 23:34:32 +00:00
217a317425
Fix wording in Functional Programming HOWTO (GH-98939)
...
(cherry picked from commit f4d56292e9
2022-10-31 19:57:42 -07:00
a4f8db19ad
Fix typo in sorting HOWTO (GH-98888)
...
(cherry picked from commit 3b86538661
2022-10-31 11:07:14 -07:00
5f86275ec2
[3.11] Change links to label refs (GH-98454) ( #98725 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 268129a74f
2022-10-26 13:18:50 -07:00
860efa3534
[3.11] [doc] Improve logging cookbook example. (GH-98481) (GH-98483)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2022-10-20 12:54:52 +01:00
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
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
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
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
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
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
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
73557d5bd2
[3.11] gh-65046: Add note about logging from async code. (GH-97602) (GH-97608)
2022-09-28 05:32:01 +01:00
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
b76c43a55a
[3.11] gh-77116: Add SMTP buffering example to logging cookbook. (GH-96324) (GH-96326)
2022-08-27 12:15:53 +01:00
d6990681b6
GH-95822: Need _PyType_Lookup() in descriptor howto code equivalent. (GH-95967) ( #96099 )
2022-08-19 00:18:44 -05:00
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
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
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
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
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
8fe0b1d8fa
[3.11] Update logging documentation: change cross-reference and add webapp r… (GH-94541)
2022-07-04 09:09:40 +01:00
8b77681469
bpo-39971: Change examples to be runnable (GH-32172)
...
(cherry picked from commit c57a1c76d7
2022-06-25 13:59:43 -07:00
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
7bfeb8a606
[3.11] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93647)
2022-06-09 17:28:34 +01:00
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
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
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
ebaf0945f9
GH-89519: Deprecate classmethod descriptor chaining ( #92379 )
2022-05-06 02:57:53 -05:00
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
53ca774497
sorting howto: Add clarification on < using __lt__ ( #92010 )
2022-04-29 16:08:07 -06:00
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
f82f9ce323
Remove python2 support in logging cookbook example. (GH-32362)
2022-04-06 17:57:54 +01:00
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
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
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
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
12a2e41e8a
Improve discussion about how __getattr__ is invoked. (GH-31435)
2022-02-19 23:02:30 -06:00
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
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
ba650af7d6
Optimize images by IMGbot (GH-21348)
...
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
2022-02-04 15:49:43 +09:00
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
d05a66339b
no-issue: Fix documentation typos. (GH-30576)
2022-01-20 17:17:15 +09:00
83d544b929
bpo-40066: [Enum] skip failing doc test (GH-30637)
2022-01-17 07:18:13 -08:00
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
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
6223cbf86a
bpo-45331: [Enum] add rule to docs that mixin type must be subclassable (GH-30521)
2022-01-10 15:42:45 -08:00
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
39b60ceae8
[Doc] Add info to logging cookbook about running logging socket listeners i… (GH-29838)
2021-11-29 13:06:52 +00:00
94daf39b2f
Fix markup buglet in Doc/howto/annotations.rst ( #29802 )
2021-11-26 14:10:01 -08:00
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
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
7c4d96103c
bpo-44174: [Enum] add reference to name mangling (GH-29116)
2021-10-20 20:32:11 -07:00
d89fb9a5a6
bpo-45320: Remove long-deprecated inspect methods (GH-28618)
2021-10-20 20:48:55 +02:00
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
977d99d1cc
Fix 404 link to the pyporting mailing list (GH-27320)
...
Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-04 20:53:58 +02:00
174fbd85f6
bpo-44399: Document another example of unexpected behavior. (GH-27407)
2021-07-28 11:46:52 +01:00
2e41df4d60
bpo-44740: Make minor edits to lowercasing "internet" and "web". (GH-27385)
...
Follow up to 11749e2dc2
2021-07-27 10:57:52 +02:00
11749e2dc2
bpo-44740: Lowercase "internet" and "web" where appropriate. ( #27378 )
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-07-27 00:11:55 +02:00
3e5b82ed7e
Small text fixes for enum.rst ( #27322 )
...
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2021-07-26 17:59:20 +02:00
9751f85914
bpo-44399: Update logging cookbook to document patterns to be avoided. (GH-27348)
2021-07-25 18:05:39 +01:00
e9f66aedf4
Remove effbot urls (GH-26308)
2021-05-22 14:09:54 +02:00
33d9bf298b
Fix error in Enum documentation example code that was referring to the wrong enum. ( #25837 )
2021-05-04 14:34:14 +02:00
49b26fa517
bpo-43987: Add "Annotations Best Practices" HOWTO doc. ( #25746 )
...
Add "Annotations Best Practices" HOWTO doc.
2021-05-01 21:19:24 -07:00
52cd6d5e1b
Use the zero argument form of super() in examples for Python3 docs. (GH-22314)
2021-04-26 15:13:54 -07:00
fe24088293
Add more tests. Fix code excerpt. (GH-25549)
2021-04-22 20:02:46 -07:00
14092b5a4a
bpo-43917: Fix pure python equivalent for classmethod (GH-25544)
...
Reported by Yahor Harunovich.
2021-04-22 17:53:36 -07:00
4f9ffa8f9c
Add doctests (GH-25474)
2021-04-19 14:12:36 -07:00
85918e4ab6
bpo-43774: Add more links to configure options (GH-25363)
2021-04-12 23:27:35 +02:00
a41782cc84
bpo-43774: Document configure options (GH-25283)
...
Add Doc/using/configure.rst documentation to document configure,
preprocessor, compiler and linker options.
Add a new section about the "Python debug build".
2021-04-08 22:32:21 +02:00
c5354c045c
Replace broken example code with correct simpler code. (GH-25162)
...
The open() was missing 'w' to indicate it was in a write-mode.
Even then, the open().close() operation was distracting because
it is an unusual way to "touch" as file. Using os.remove()
instead is simpler and less distracting.
2021-04-03 13:09:01 -07:00
e4c8895ee5
Add more tests for the descriptor tutorial (GH-25164)
2021-04-03 13:07:52 -07:00
e689cdca3c
bpo-43677: Fix a minor error in Doc/howto/descriptor.rst ( #25123 )
...
It should be PyMethod_Type, not Py_MethodType.
2021-04-01 10:03:33 -07:00
b775106d94
bpo-40066: Enum: modify `repr()` and `str()` (GH-22392)
...
* Enum: streamline repr() and str(); improve docs
- repr() is now ``enum_class.member_name``
- stdlib global enums are ``module_name.member_name``
- str() is now ``member_name``
- add HOW-TO section for ``Enum``
- change main documentation to be an API reference
2021-03-30 21:17:26 -07:00
7bfd65eba7
bpo-43648: Remove redundant datefmt option in logging file config (GH-25051)
...
[bpo-43648](): Remove redundant datefmt option in logging file config
Automerge-Triggered-By: GH:vsajip
2021-03-29 07:16:19 -07:00
f00e82f8b8
bpo-43427: Separte the method overview from the static method specifics. (GH-24787)
2021-03-13 13:46:32 -08:00
5f18c22339
Simple typo fix (GH-24448)
2021-02-05 10:17:01 -08:00
755c6e637a
Minor readability improvements. Also note performance impact of __slots__. (GH-24456)
2021-02-04 22:05:42 -08:00
a98fe02d73
bpo-43082: Remove redundant 'the' in Descriptor howto (GH-24394)
2021-02-02 19:28:36 -08:00
e982fe496b
bpo-42048: Clinic Howto: Document AC's defining_class converter (GH-23978)
2021-01-20 12:19:57 +01:00
c56387f80c
bpo-27794: Add `name` attribute to `property` class (GH-23967)
2020-12-30 01:51:24 -08:00
Miss Islington (bot)