summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* gh-64658: Expand Argument Clinic return converter docs (#104175)Erlend E. Aasland2023-05-051-13/+28
|
* gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules (#103457)Hugo van Kemenade2023-05-031-21/+23
| | | | Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* GH-103484: Fix redirected permanently URLs (#104001)Rafael Fontenelle2023-05-021-1/+1
| | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
* gh-101100: Fix Sphinx warnings in `argparse` module (#103289)Hugo van Kemenade2023-04-241-7/+9
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* GH-103484: Fix broken links reported by linkcheck (#103608)Rafael Fontenelle2023-04-222-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Doc: Fix broken links reported by linkcheck * Apply suggestions from code review - Remove extra diff line in faq/library.rst (merwok) - Use HTTPS to link Unicode 15.0.0 to solve a redirect (hugovk) - Use wayback machine link for openssl 1.1.0 instead of linking 1.1.1, "as this text mentions a feature from 1.1.0" (hugovk) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Make mark-up code as literal * Doc: Alphabetize items in linkcheck_ignore Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Improve comment in sphinx conf Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --------- 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>
* Descriptor HowTo: Update to include attributes added in Python 3.10 ↵Raymond Hettinger2023-04-221-8/+90
| | | | (GH-103666)
* gh-103596: [Enum] do not shadow mixed-in methods/attributes (GH-103600)Ethan Furman2023-04-181-3/+11
| | | | | | | | | | | | | | | | | | For example: class Book(StrEnum): title = auto() author = auto() desc = auto() Book.author.desc is Book.desc but Book.author.title() == 'Author' is commonly expected. Using upper-case member names avoids this confusion and possible performance impacts. Co-authored-by: samypr100 <3933065+samypr100@users.noreply.github.com>
* Fix syntax typo in isolating extensions doc (#103516)AN Long2023-04-141-3/+3
|
* Proofread howto/perf_profiling.rst (#103530)Boris Verkhovskiy2023-04-141-10/+10
|
* gh-103479: [Enum] require __new__ to be considered a data type (GH-103495)Ethan Furman2023-04-131-3/+5
| | | a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type
* gh-93910: [Enum] remove member.member deprecation (GH-103236)Ethan Furman2023-04-061-4/+3
| | | | i.e. Color.RED.BLUE is now officially supported.
* gh-103056: [Enum] use staticmethod decorator for _gnv_ (GH-103231)Ethan Furman2023-04-041-0/+1
| | | _gnv_ --> _generate_next_value_
* gh-98298, gh-74730: [Enum] update docs (GH-103163)Ethan Furman2023-04-031-0/+5
| | | | fix FlagBoundary statements add warning about reloading modules and enum identity
* gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635)Matěj Cepl2023-03-291-10/+14
|
* [doc] Improve grammar/fix missing word (GH-102060)VMan2023-02-261-1/+1
|
* gh-101440: fix json snippet error in logging-cookbook.rst (#101439)Peter Jiping Xie2023-01-311-1/+1
|
* gh-101386: fix typos found by codespell (#101387)Peter Jiping Xie2023-01-281-2/+2
|
* Provided better example for logging cookbook (GH-101164)Vladimir Malinovskii2023-01-201-10/+31
| | | Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* gh-98763: Prefer "python" over "python3" for command line examples in docs. ↵Mariusz Felisiak2023-01-113-56/+56
| | | | (#98761)
* gh-100916: Convert argument to appropriate type (GH-100917)Yao-Ching Huang2023-01-101-1/+1
|
* gh-99535: Add test for inheritance of annotations and update documentation ↵MonadChains2022-12-241-0/+6
| | | | (#99990)
* gh-99087: Add missing newline for prompts in docs (GH-98993)Stanley2022-12-091-0/+2
| | | Add newline for prompts so copying to REPL does not cause errors.
* gh-94943: [Enum] improve repr() when inheriting from a dataclass (GH-99740)Ethan Furman2022-12-061-0/+25
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)Ethan Furman2022-11-121-3/+46
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [Enum] Typo: fix DuplicateFreeEnum example docs (GH-99265)Bruno Neyra2022-11-091-1/+1
|
* argparse howto: Use f-string in preference to "...".format() (#98883)Skip Montanaro2022-11-031-2/+2
|
* [doc] Update cookbook example for socket-based logging in a production ↵Vinay Sajip2022-11-011-7/+65
| | | | | sett… (GH-98922) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Fix wording in Functional Programming HOWTO (GH-98939)partev2022-11-011-1/+1
|
* Fix typo in sorting HOWTO (#98888)partev2022-10-311-1/+1
|
* gh-96143: Improve perf profiler docs (#96445)Erlend E. Aasland2022-10-271-31/+38
|
* docs: Change links to label refs (#98454)Stanley2022-10-262-1/+3
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [doc] Improve logging cookbook example. (GH-98481)Vinay Sajip2022-10-201-0/+65
|
* GH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (GH-98336)Raymond Hettinger2022-10-161-76/+22
|
* [doc] Update logging cookbook with an example of custom handling of levels. ↵Vinay Sajip2022-10-151-4/+206
| | | | | (GH-98290) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-65046: Link to logging cookbook from asyncio docs (#98207)Shantanu2022-10-121-0/+2
|
* Minor edits to the Descriptor HowTo Guide (GH-24901)Géry Ogam2022-10-091-6/+8
| | | Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* gh-97956: Mention `generate_global_objects.py` in `AC How-To` (#97957)Nikita Sobolev2022-10-071-1/+9
|
* Docs: Fix backtick errors found by sphinx-lint (#97998)Hugo van Kemenade2022-10-074-9/+9
| | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* gh-93738: Disallow pre-v3 syntax in the C domain (#97962)Adam Turner2022-10-061-1/+1
| | | Also, disable using invalid sphinx-lint 0.6.2.
* I changed my surname early this year (#96671)Tshepang Mbambo2022-10-051-1/+1
| | | | | * I recently changed my name * Update ACKS
* gh-97681: Remove Tools/demo/ directory (#97682)Victor Stinner2022-10-031-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Remove the Tools/demo/ directory which contained old demo scripts. A copy can be found in the old-demos project: https://github.com/gvanrossum/old-demos Remove the following old demo scripts: * beer.py * eiffel.py * hanoi.py * life.py * markov.py * mcast.py * queens.py * redemo.py * rpython.py * rpythond.py * sortvisu.py * spreadsheet.py * vector.py Changes: * Remove a reference to the redemo.py script in the regex howto documentation. * Remove a reference to the removed Tools/demo/ directory in the curses documentation. * Update PC/layout/ to remove the reference to Tools/demo/ directory.
* [docs] Update logging cookbook with recipe for using a logger like an ↵Vinay Sajip2022-10-021-0/+76
| | | | output… (GH-97730)
* gh-65046: Add note about logging from async code. (GH-97602)Vinay Sajip2022-09-281-0/+8
|
* gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)Serhiy Storchaka2022-09-241-1/+1
|
* gh-96143: Add some comments and minor fixes missed in the original PR (#96433)Pablo Galindo Salgado2022-08-301-0/+3
| | | | | | | | | * gh-96132: Add some comments and minor fixes missed in the original PR * Update Doc/using/cmdline.rst Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* gh-96143: Allow Linux perf profiler to see Python calls (GH-96123)Pablo Galindo Salgado2022-08-302-0/+201
| | | | | | | :warning: :warning: Note for reviewers, hackers and fellow systems/low-level/compiler engineers :warning: :warning: If you have a lot of experience with this kind of shenanigans and want to improve the **first** version, **please make a PR against my branch** or **reach out by email** or **suggest code changes directly on GitHub**. If you have any **refinements or optimizations** please, wait until the first version is merged before starting hacking or proposing those so we can keep this PR productive.
* gh-77116: Add SMTP buffering example to logging cookbook. (GH-96324)Vinay Sajip2022-08-261-0/+82
|
* GH-95822: Need _PyType_Lookup() in descriptor howto code equivalent. (GH-95967)Raymond Hettinger2022-08-191-1/+21
|
* Docs: replace 'currying' by 'partial function'. (#91814)Clemens Tolboom2022-08-111-0/+2
|
* gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)Serhiy Storchaka2022-08-041-1/+1
| | | | It updates links which redirect to HTTPS with different authority or path.