summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* sorting howto: Add clarification on < using __lt__ (#92010)slateny2022-04-291-1/+4
|
* gh-91156: Use `locale.getencoding()` instead of getpreferredencoding (GH-91732)Inada Naoki2022-04-221-2/+1
| | | Co-authored-by: Victor Stinner <vstinner@python.org>
* Remove python2 support in logging cookbook example. (GH-32362)Mathieu Dupuy2022-04-061-8/+1
|
* bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)Mike cm2022-04-051-1/+1
| | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* bpo-14911: Corrected generator.throw() documentation (GH-32207)Dave Goncalves2022-03-311-1/+1
| | | Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
* bpo-47081: Replace "qualifiers" with "quantifiers" in the re module ↵Serhiy Storchaka2022-03-221-6/+6
| | | | | documentation (GH-32028) It is a more commonly used term.
* [doc] Add a note in howto/logging.rst about "do not log to root logger in ↵Yuxin Wu2022-02-261-0/+7
| | | | libraries" (GH-31271)
* Improve discussion about how __getattr__ is invoked. (GH-31435)Raymond Hettinger2022-02-201-9/+7
|
* bpo-46730: Add more info to @property AttributeError messages (GH-31311)Alex-Blade2022-02-161-4/+4
| | | On `obj.read_only_property = x`, raise `AttributeError: property 'read_only_property' of 'A' object has no setter`.
* bpo-46613: Add PyType_GetModuleByDef to the public API (GH-31081)Petr Viktorin2022-02-111-3/+3
| | | | | * Make PyType_GetModuleByDef public (remove underscore) Co-authored-by: Victor Stinner <vstinner@python.org>
* Optimize images by IMGbot (GH-21348)Manish Kumar ⛄2022-02-041-0/+0
| | | Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
* [doc]: Spotted errors while working on rstlint. (GH-30879)Julien Palard2022-01-271-2/+1
| | | | Also ignored some `make suspicious` false positives while assuring true positives were properly seen by rstlint.
* no-issue: Fix documentation typos. (GH-30576)Piotr Fusik2022-01-201-1/+1
|
* bpo-40066: [Enum] skip failing doc test (GH-30637)Kumar Aditya2022-01-171-146/+126
|
* Revert "bpo-40066: [Enum] update str() and format() output (GH-30582)" ↵Victor Stinner2022-01-171-126/+146
| | | | | (GH-30632) This reverts commit acf7403f9baea3ae1119fc6b4a3298522188bf96.
* bpo-40066: [Enum] update str() and format() output (GH-30582)Ethan Furman2022-01-161-146/+126
| | | | | | | | | | | | | | | 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`
* bpo-45331: [Enum] add rule to docs that mixin type must be subclassable ↵Nikita Sobolev2022-01-101-4/+7
| | | | (GH-30521)
* bpo-45535: Improve output of Enum ``dir()`` (GH-29316)Alex Waygood2021-12-021-3/+4
| | | | | | 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.
* [Doc] Add info to logging cookbook about running logging socket listeners ↵Vinay Sajip2021-11-291-0/+22
| | | | i… (GH-29838)
* Fix markup buglet in Doc/howto/annotations.rst (#29802)Guido van Rossum2021-11-261-1/+1
|
* bpo-19072: Classmethod can wrap other classmethod like descriptors (GH-29634)Raymond Hettinger2021-11-191-1/+8
| | | | | | staticmethod() also became callable in Python 3.10. See: b83861f02.
* bpo-45740: [Enum] add versionadded markers to docs (GH-29443)Ethan Furman2021-11-061-7/+6
| | | [Enum] add versionadded markers to docs
* bpo-44174: [Enum] add reference to name mangling (GH-29116)Ethan Furman2021-10-211-1/+2
|
* bpo-45320: Remove long-deprecated inspect methods (GH-28618)Hugo van Kemenade2021-10-201-3/+0
|
* bpo-34804: [doc] Rephrase section on side effects in functional.rst for ↵DonnaDia2021-10-061-5/+4
| | | | | clarity (GH-27989) Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* Fix 404 link to the pyporting mailing list (GH-27320)Rohit Nishad2021-08-041-3/+3
| | | | Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-44399: Document another example of unexpected behavior. (GH-27407)Vinay Sajip2021-07-281-1/+3
|
* bpo-44740: Make minor edits to lowercasing "internet" and "web". (GH-27385)Mariusz Felisiak2021-07-271-1/+1
| | | Follow up to 11749e2dc20ad6a76e9a39e948853e89b2b4bbed
* bpo-44740: Lowercase "internet" and "web" where appropriate. (#27378)Mariusz Felisiak2021-07-263-3/+3
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* Small text fixes for enum.rst (#27322)Elliot Waite2021-07-261-8/+9
| | | Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* bpo-44399: Update logging cookbook to document patterns to be avoided. ↵Vinay Sajip2021-07-251-0/+79
| | | | (GH-27348)
* Remove effbot urls (GH-26308)E-Paine2021-05-221-5/+1
|
* Fix error in Enum documentation example code that was referring to the wrong ↵krisaoe2021-05-041-1/+1
| | | | enum. (#25837)
* bpo-43987: Add "Annotations Best Practices" HOWTO doc. (#25746)larryhastings2021-05-022-0/+227
| | | Add "Annotations Best Practices" HOWTO doc.
* Use the zero argument form of super() in examples for Python3 docs. (GH-22314)Andre Delfino2021-04-261-6/+6
|
* Add more tests. Fix code excerpt. (GH-25549)Raymond Hettinger2021-04-231-3/+18
|
* bpo-43917: Fix pure python equivalent for classmethod (GH-25544)Raymond Hettinger2021-04-231-1/+12
| | | Reported by Yahor Harunovich.
* Add doctests (GH-25474)Raymond Hettinger2021-04-191-3/+45
|
* bpo-43774: Add more links to configure options (GH-25363)Victor Stinner2021-04-121-3/+5
|
* bpo-43774: Document configure options (GH-25283)Victor Stinner2021-04-081-1/+1
| | | | | | Add Doc/using/configure.rst documentation to document configure, preprocessor, compiler and linker options. Add a new section about the "Python debug build".
* Replace broken example code with correct simpler code. (GH-25162)Raymond Hettinger2021-04-031-2/+2
| | | | | | 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.
* Add more tests for the descriptor tutorial (GH-25164)Raymond Hettinger2021-04-031-7/+57
|
* bpo-43677: Fix a minor error in Doc/howto/descriptor.rst (#25123)Zackery Spytz2021-04-011-1/+1
| | | It should be PyMethod_Type, not Py_MethodType.
* bpo-40066: Enum: modify `repr()` and `str()` (GH-22392)Ethan Furman2021-03-312-0/+1417
| | | | | | | | | * 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
* bpo-43648: Remove redundant datefmt option in logging file config (GH-25051)Harry2021-03-291-1/+0
| | | | | [bpo-43648](): Remove redundant datefmt option in logging file config Automerge-Triggered-By: GH:vsajip
* bpo-43427: Separte the method overview from the static method specifics. ↵Raymond Hettinger2021-03-131-2/+6
| | | | (GH-24787)
* Simple typo fix (GH-24448)Andrew Tennikoff2021-02-051-1/+1
|
* Minor readability improvements. Also note performance impact of __slots__. ↵Raymond Hettinger2021-02-051-8/+11
| | | | (GH-24456)
* bpo-43082: Remove redundant 'the' in Descriptor howto (GH-24394)diegoe2021-02-031-1/+1
|
* bpo-42048: Clinic Howto: Document AC's defining_class converter (GH-23978)Erlend Egeberg Aasland2021-01-201-0/+62
|