Commit Graph

849 Commits

Author SHA1 Message Date
Erlend E. Aasland ec0c0c8692
[3.11] Docs: clean up Argument Clinic howto's (#107797) (#107800)
(cherry picked from commit 34cafd35e3)

- fix formatting in @text_signature howto and NEWS entry
2023-08-09 07:54:32 +00:00
Erlend E. Aasland b0b26af822
[3.11] gh-86457: Add docs for Argument Clinic @text_signature directive (#107747) (#107799)
(cherry picked from commit a9aeb99579)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-09 09:25:25 +02:00
Miss Islington (bot) d58c74c335
[3.11] Docs: Argument Clinic: Move the CConverter class to the reference (GH-107671) (#107702)
(cherry picked from commit a6675b1a59)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-07 00:17:41 +00:00
Miss Islington (bot) e4b5ec71fe
[3.11] Docs: Argument Clinic: Improve 'How to write a custom converter' (GH-107328) (#107670)
- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)

(cherry picked from commit 4a5b4221e3)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-08-05 20:29:31 +00:00
Miss Islington (bot) 7e834c4554
[3.11] gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445) (#107655)
gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445)

gh-107432 Fix incorrect indentation in annotations document

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
(cherry picked from commit 5e2746d6e2)

Co-authored-by: Daniele Procida <daniele@vurt.org>
2023-08-05 14:40:44 +03:00
Miss Islington (bot) 3be07c98b3
[3.11] gh-107507: Replace 'The goals of Argument Clinic' with a summary (GH-107508) (#107517)
Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
(cherry picked from commit abb71c6a8f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-07-31 21:43:16 +00:00
Miss Islington (bot) 3c1bcae075
[3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
(cherry picked from commit f2d07d3289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-29 09:17:20 +03:00
Serhiy Storchaka d9392c0c0a
[3.11] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) (GH-107381)
(cherry picked from commit 983305268e)
2023-07-28 08:31:49 +00:00
Erlend E. Aasland 00b65da493
[3.11] Docs: Argument Clinic: Restructure "Basic concepts and usage" (#106981) (#107327)
Split "Basic concepts and usage" into:

- Reference
  - Terminology
  - CLI reference

- Background
  - Basic concepts

(cherry picked from commit 2ad699002e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-27 01:26:04 +02:00
Erlend E. Aasland 55edee247c
[3.11] Docs: Remove the numbered steps from the Argument Clinic tutorial (#107203) (#107319)
Instead, order the tutorial as one body of prose, making it easier to
align the tutorial according to Diátaxis principles.

(cherry picked from commit 592395577c)
2023-07-26 21:21:28 +00:00
Serhiy Storchaka cfa9f3b7cc
[3.11] gh-107091: Fix some uses of :c:member: role (GH-107129) (GH-107311)
(cherry picked from commit af61cb9c78)
2023-07-26 19:35:16 +00:00
Erlend E. Aasland 604eb04059
[3.11] Docs: Add missing markup to Argument Clinic docs (#106876) (#107182)
(cherry picked from commit ff5f94b72c)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-24 15:45:13 +00:00
Miss Islington (bot) 798d83bec8
[3.11] Docs: Remove duplicate word in Argument Clinic howto heading (GH-107169) (#107172)
(cherry picked from commit ebe44a5155)

Co-authored-by: Hakan Celik <hakancelikdev@gmail.com>
2023-07-24 12:06:06 +00:00
Erlend E. Aasland b3e600a632
[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) (#107157)
(cherry picked from commit b447e19e72)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 23:49:48 +02:00
Serhiy Storchaka d2cdf0888b
[3.11] gh-107091: Fix the use of some C domain roles (GH-107092) (GH-107121)
(cherry picked from commit 08a228da05)
2023-07-23 15:06:32 +03:00
wulmer c51f766ebb
[3.11] gh-101100: Fix some broken sphinx references (GH-107095). (#107120) 2023-07-23 05:56:09 -06:00
Miss Islington (bot) 65e40aaed0
[3.11] gh-54738: Add argparse i18n howto (GH-104562) (#107101)
(cherry picked from commit dcd7acb04a)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2023-07-23 11:23:51 +02:00
Serhiy Storchaka 6bde1b9f04
[3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) (GH-106952)
(cherry picked from commit fcc816dbff)
2023-07-21 14:48:30 +03:00
Miss Islington (bot) 0a57620887
[3.11] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) (#106946)
Add Background as a toplevel section with the following subsections:

- Background
  - The goals of Argument Clinic
  - Basic concepts and usage

Rename "Converting your first function" to Tutorial.

Add anchors for Background, Tutorial, and How-to Guides:

- :ref:`clinic-background`
- :ref:`clinic-tutorial`
- :ref:`clinic-howtos`

Link to these from within the Abstract.

Break the compatibility paragraph out of Abstract and make it a note.
(cherry picked from commit 81861fd90b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-21 08:32:56 +02:00
Miss Islington (bot) 0c47ed7bbf
[3.11] Docs: Argument Clinic: Group guides about default values (GH-106872) (#106873)
Docs: Argument Clinic: Group guides about default values (GH-106872)

Previous ToC layout (excerpt):

    - How to use symbolic default values
    ...
    - How to assign default values to parameter
      - How to use the ``NULL`` default value
      - How to use expressions as default values

New layout:

    - How to assign default values to parameter
      - The ``NULL`` default value
      - Symbolic default values
      - Expressions as default values

(cherry picked from commit 505eede38d)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-07-19 01:16:04 +02:00
Miss Islington (bot) 38553442c8
[3.11] Docs: Normalise Argument Clinic advanced topics headings (GH-106842) (#106852)
(cherry picked from commit 4cb0b9c0a9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-18 12:25:25 +02:00
Miss Islington (bot) c73f9c045e
[3.11] Docs: Normalize Argument Clinic How-To section capitalization (GH-106788) (#106792)
(cherry picked from commit 8c17729489)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-07-16 00:50:43 +02:00
Miss Islington (bot) fed1b5a198
[3.11] gh-105332: [Enum] Fix unpickling flags in edge-cases (GH-105348) (GH-105519)
* revert enum pickling from by-name to by-value

(cherry picked from commit 4ff5690e59)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-06-08 18:02:12 -07:00
Miss Islington (bot) be20e9c647
[3.11] howto/urllib2: remove link to an outdated french translation (GH-104193) (GH-104746)
howto/urllib2: remove link to an outdated french translation (GH-104193)

We now have our own translation and it's not outdated
(cherry picked from commit 151b6bfb5d)

Co-authored-by: Mathieu Dupuy <deronnax@gmail.com>
2023-05-22 19:57:05 +02:00
Miss Islington (bot) 03abac239c
[3.11] gh-103960: Dark mode: invert image brightness (GH-103983) (#104358)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-10 14:19:38 +00:00
Miss Islington (bot) 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
Erlend E. Aasland a635d63860
[3.11] gh-64658: Expand Argument Clinic return converter docs (#104175) (#104198) 2023-05-05 13:46:23 +02:00
Miss Islington (bot) 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
Rafael Fontenelle 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
Hugo van Kemenade 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
Miss Islington (bot) 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)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-04-24 15:05:14 +05:30
Rafael Fontenelle 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
Ethan Furman 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)
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-13 12:04:06 -07:00
Ethan Furman 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)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-05 21:29:14 -07:00
Miss Islington (bot) 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)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-03 15:27:33 -07:00
Miss Islington (bot) d189e2db0b
[3.11] gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635) (GH-103106)
(cherry picked from commit d835b3f05d)

Co-authored-by: Matěj Cepl <mcepl@cepl.eu>
2023-03-29 10:04:53 +01:00
Miss Islington (bot) 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)

Co-authored-by: VMan <vayidm@users.noreply.github.com>
2023-02-26 18:58:55 +05:30
Miss Islington (bot) 5e498072dc
[3.11] gh-101440: fix json snippet error in logging-cookbook.rst (GH-101439) (GH-101463)
(cherry picked from commit 20c11f2e60)

Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com>

Automerge-Triggered-By: GH:hugovk
2023-01-31 07:51:48 -08:00
Miss Islington (bot) 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
Miss Islington (bot) 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
Miss Islington (bot) 44b664e057
gh-99535: Add test for inheritance of annotations and update documentation (GH-99990)
(cherry picked from commit f5b7b19bf1)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-12-24 12:31:10 -08:00
Miss Islington (bot) 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)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-12 10:43:32 -08:00
Miss Islington (bot) cf5dbb47a2
[Enum] Typo: fix DuplicateFreeEnum example docs (GH-99265)
(cherry picked from commit b3bd69c1bf)

Co-authored-by: Bruno Neyra <112962296+blv-brunoneyra@users.noreply.github.com>
2022-11-08 16:51:04 -08:00
Miss Islington (bot) 8b4d5b1047
argparse howto: Use f-string in preference to "...".format() (GH-98883)
(cherry picked from commit 1fd20d0b57)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2022-11-02 19:17:33 -07:00
Miss Islington (bot) 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
Miss Islington (bot) 217a317425
Fix wording in Functional Programming HOWTO (GH-98939)
(cherry picked from commit f4d56292e9)

Co-authored-by: partev <petrosyan@gmail.com>
2022-10-31 19:57:42 -07:00
Miss Islington (bot) a4f8db19ad
Fix typo in sorting HOWTO (GH-98888)
(cherry picked from commit 3b86538661)

Co-authored-by: partev <petrosyan@gmail.com>
2022-10-31 11:07:14 -07:00
Stanley 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
Miss Islington (bot) 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
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)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-18 01:49:38 +02:00