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
slateny
Inada Naoki
Mathieu Dupuy
Mike cm
Dave Goncalves
Serhiy Storchaka
Yuxin Wu
Raymond Hettinger
Alex-Blade
Petr Viktorin
Manish Kumar ⛄
Julien Palard
Piotr Fusik
Kumar Aditya
Victor Stinner
Ethan Furman
Nikita Sobolev
Alex Waygood
Vinay Sajip
Guido van Rossum
Hugo van Kemenade
DonnaDia
Rohit Nishad
Mariusz Felisiak
Elliot Waite
E-Paine
krisaoe
larryhastings
Andre Delfino
Zackery Spytz
Harry
Andrew Tennikoff
diegoe
Erlend Egeberg Aasland