33cb0b06ef
gh-95065: Add Argument Clinic support for deprecating positional use of parameters ( #95151 )
...
It is now possible to deprecate passing parameters positionally with
Argument Clinic, using the new '* [from X.Y]' syntax.
(To be read as "keyword-only from Python version X.Y")
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-07 11:28:08 +00:00
a6675b1a59
Docs: Argument Clinic: Move the CConverter class to the reference ( #107671 )
2023-08-07 02:08:34 +02:00
4a5b4221e3
Docs: Argument Clinic: Improve 'How to write a custom converter' ( #107328 )
...
- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-08-05 20:19:37 +00:00
5e2746d6e2
gh-107432 Fix incorrect indentation in annotations HOWTO ( #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.
2023-08-05 14:28:28 +03:00
fb344e99aa
gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters ( #107403 )
...
It was added in 3.12 for PEP 684 (per-interpreter GIL).
2023-07-31 17:03:01 -06:00
abb71c6a8f
gh-107507: Replace 'The goals of Argument Clinic' with a summary ( #107508 )
...
Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
2023-07-31 23:33:13 +02:00
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
2ad699002e
Docs: Argument Clinic: Restructure "Basic concepts and usage" ( #106981 )
...
Split "Basic concepts and usage" into:
- Reference
- Terminology
- CLI reference
- Background
- Basic concepts
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-26 22:08:43 +00:00
592395577c
Docs: Remove the numbered steps from the Argument Clinic tutorial ( #107203 )
...
Instead, order the tutorial as one body of prose, making it easier to
align the tutorial according to Diátaxis principles.
2023-07-26 22:54:25 +02:00
af61cb9c78
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
ff5f94b72c
Docs: Add missing markup to Argument Clinic docs ( #106876 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-24 15:22:18 +00:00
ebe44a5155
Docs: Remove duplicate word in Argument Clinic howto heading ( #107169 )
2023-07-24 13:54:39 +02:00
b447e19e72
gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls ( #107062 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 22:56:56 +02:00
08a228da05
gh-107091: Fix the use of some C domain roles ( #107092 )
2023-07-23 12:27:05 +02:00
f5147c0cfb
gh-101100: Fix some broken sphinx references ( #107095 )
2023-07-23 03:23:44 -06:00
dcd7acb04a
gh-54738: Add argparse i18n howto ( #104562 )
2023-07-23 11:10:38 +02:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
81861fd90b
Docs: Argument Clinic: Add Background and Tutorial top-level sections ( #106904 )
...
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.
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-21 08:05:41 +02:00
505eede38d
Docs: Argument Clinic: Group guides about default values ( #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
2023-07-19 00:46:50 +02:00
4cb0b9c0a9
Docs: Normalise Argument Clinic advanced topics headings ( #106842 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-18 10:50:17 +02:00
8c17729489
Docs: Normalize Argument Clinic How-To section capitalization ( #106788 )
2023-07-16 00:42:58 +02:00
4ff5690e59
gh-105332: [Enum] Fix unpickling flags in edge-cases (GH-105348)
...
* revert enum pickling from by-name to by-value
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-06-08 11:40:15 -07:00
bae415ad02
gh-102304: doc: Add links to Stable ABI and Limited C API ( #105345 )
...
* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:
- Lib/test/test_stable_abi_ctypes.py
- PC/python3dll.c
2023-06-06 08:40:32 +00:00
151b6bfb5d
howto/urllib2: remove link to an outdated french translation (GH-104193)
...
We now have our own translation and it's not outdated
2023-05-22 15:03:29 +02:00
be0c106789
gh-103295: expose API for writing perf map files ( #103546 )
...
Co-authored-by: Aniket Panse <aniketpanse@fb.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Carl Meyer <carl@oddbird.net>
2023-05-21 11:12:24 +01:00
b2c1b4da19
gh-104389: Add 'unused' keyword to Argument Clinic C converters ( #104390 )
...
Use the unused keyword param in the converter to explicitly
mark an argument as unused:
/*[clinic input]
SomeBaseClass.stubmethod
flag: bool(unused=True)
[clinic start generated code]*/
2023-05-12 10:34:00 +02:00
13ac1766bc
gh-103960: Dark mode: invert image brightness ( #103983 )
2023-05-10 16:46:37 +03:00
721a78395d
gh-64658: Expand Argument Clinic return converter docs ( #104175 )
2023-05-05 13:32:00 +02:00
5b05b013ff
gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules ( #103457 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 23:09:04 -06:00
68ed2a2a3f
GH-103484: Fix redirected permanently URLs ( #104001 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
2023-05-02 09:34:44 +03:00
79ae019164
gh-101100: Fix Sphinx warnings in `argparse` module ( #103289 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 15:36:32 -06:00
caed49448d
GH-103484: Fix broken links reported by linkcheck ( #103608 )
...
* 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>
2023-04-22 08:24:47 -06:00
7b134d3e71
Descriptor HowTo: Update to include attributes added in Python 3.10 (GH-103666)
2023-04-22 08:29:40 -05:00
700ec657c8
gh-103596: [Enum] do not shadow mixed-in methods/attributes (GH-103600)
...
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>
2023-04-18 16:19:23 -07:00
282f0d26e3
Fix syntax typo in isolating extensions doc ( #103516 )
2023-04-14 00:40:25 -07:00
a3d313a9e2
Proofread howto/perf_profiling.rst ( #103530 )
2023-04-13 20:07:49 -07:00
a6f95941a3
gh-103479: [Enum] require __new__ to be considered a data type (GH-103495)
...
a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type
2023-04-13 08:31:03 -07:00
4ec8dd10bd
gh-93910: [Enum] remove member.member deprecation (GH-103236)
...
i.e. Color.RED.BLUE is now officially supported.
2023-04-05 17:33:52 -07:00
810d365b5e
gh-103056: [Enum] use staticmethod decorator for _gnv_ (GH-103231)
...
_gnv_ --> _generate_next_value_
2023-04-03 17:47:40 -07:00
5ffc1e5a21
gh-98298, gh-74730: [Enum] update docs (GH-103163)
...
fix FlagBoundary statements
add warning about reloading modules and enum identity
2023-04-03 14:57:42 -07:00
d835b3f05d
gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635)
2023-03-29 09:52:53 +01:00
6daf42b28e
[doc] Improve grammar/fix missing word (GH-102060)
2023-02-26 18:45:27 +05:30
20c11f2e60
gh-101440: fix json snippet error in logging-cookbook.rst ( #101439 )
2023-01-31 17:30:38 +02:00
db757f0e44
gh-101386: fix typos found by codespell ( #101387 )
2023-01-28 11:57:40 +02:00
8cdbc46090
Provided better example for logging cookbook (GH-101164)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-20 08:54:48 +00:00
847d7708ba
gh-98763: Prefer "python" over "python3" for command line examples in docs. ( #98761 )
2023-01-11 15:35:41 +05:30
b2f7b2ef0b
gh-100916: Convert argument to appropriate type (GH-100917)
2023-01-10 10:17:57 +00:00
f5b7b19bf1
gh-99535: Add test for inheritance of annotations and update documentation ( #99990 )
2022-12-24 12:07:14 -08:00
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
679efbb080
gh-94943: [Enum] improve repr() when inheriting from a dataclass (GH-99740)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-06 13:43:41 -08:00
73a921b070
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-12 10:39:47 -08:00
b3bd69c1bf
[Enum] Typo: fix DuplicateFreeEnum example docs (GH-99265)
2022-11-08 16:39:56 -08:00
1fd20d0b57
argparse howto: Use f-string in preference to "...".format() ( #98883 )
2022-11-02 19:08:08 -07:00
50a9b037a6
[doc] Update cookbook example for socket-based logging in a production sett… (GH-98922)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-01 23:00:17 +00:00
f4d56292e9
Fix wording in Functional Programming HOWTO (GH-98939)
2022-10-31 21:49:27 -05:00
3b86538661
Fix typo in sorting HOWTO ( #98888 )
2022-10-31 12:58:13 -05:00
723ebe76e7
gh-96143: Improve perf profiler docs ( #96445 )
2022-10-27 14:06:48 +01:00
268129a74f
docs: Change links to label refs ( #98454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-25 20:26:28 -07:00
a956c2fd55
[doc] Improve logging cookbook example. (GH-98481)
2022-10-20 12:46:03 +01:00
ae19217867
GH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (GH-98336)
2022-10-16 14:34:25 -05:00
11c25a402d
[doc] Update logging cookbook with an example of custom handling of levels. (GH-98290)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-15 21:23:06 +01:00
c39a0c3354
gh-65046: Link to logging cookbook from asyncio docs ( #98207 )
2022-10-11 21:42:57 -07:00
2d2e01aa4c
Minor edits to the Descriptor HowTo Guide (GH-24901)
...
Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-08 20:54:21 -05:00
586cfb0131
gh-97956: Mention `generate_global_objects.py` in `AC How-To` ( #97957 )
2022-10-07 11:54:45 -07:00
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
f612565bd3
gh-93738: Disallow pre-v3 syntax in the C domain ( #97962 )
...
Also, disable using invalid sphinx-lint 0.6.2.
2022-10-06 10:11:37 -07:00
815008a3a5
I changed my surname early this year ( #96671 )
...
* I recently changed my name
* Update ACKS
2022-10-05 11:16:45 -07:00
64fe343717
gh-97681: Remove Tools/demo/ directory ( #97682 )
...
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.
2022-10-03 17:09:02 +02:00
cac2e8a51f
[docs] Update logging cookbook with recipe for using a logger like an output… (GH-97730)
2022-10-02 14:26:14 +01:00
5c110d1126
gh-65046: Add note about logging from async code. (GH-97602)
2022-09-28 05:17:42 +01:00
db39050396
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
2022-09-24 14:38:53 +03:00
f49dd54b72
gh-96143: Add some comments and minor fixes missed in the original PR ( #96433 )
...
* 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>
2022-08-30 19:37:22 +01:00
6d791a9736
gh-96143: Allow Linux perf profiler to see Python calls (GH-96123)
...
⚠️ ⚠️ Note for reviewers, hackers and fellow systems/low-level/compiler engineers ⚠️ ⚠️
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.
2022-08-30 10:11:18 -07:00
43a6deadbb
gh-77116: Add SMTP buffering example to logging cookbook. (GH-96324)
2022-08-27 00:24:36 +01:00
6740680b57
GH-95822: Need _PyType_Lookup() in descriptor howto code equivalent. (GH-95967)
2022-08-18 23:56:58 -05:00
b9e956fccf
Docs: replace 'currying' by 'partial function'. ( #91814 )
2022-08-11 01:23:40 -05:00
d0d0154443
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
...
It updates links which redirect to HTTPS with different authority or
path.
2022-08-04 13:30:05 +03:00
f79547a429
gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527)
...
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.
2022-08-04 10:13:49 +03:00
347c783673
gh-95007: Remove the NoneType return converter from Argument Clinic Doc ( #95529 )
...
The converter was removed in 74b5e4ce80
2022-08-01 15:07:35 +02:00
4e704d7847
gh-95077: [Enum] add code-based deprecation warnings for member.member access (GH-95083)
...
* issue deprecation warning for member.member access
* always store member property in current class
* remove __getattr__
2022-07-25 11:05:10 -07:00
dc54193095
[doc] Update cookbook example and add information about queue types. (GH-94854)
2022-07-15 06:03:58 +01:00
e6ec6f5b50
Docs: Convert PEP 630 (Isolating Extension Modules) to a HOWTO (GH-94489)
...
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-07-05 16:37:28 +02:00
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
2022-07-05 11:16:10 +02:00
a391b74dbe
Update logging documentation: change cross-reference and add webapp r… (GH-94540)
2022-07-04 06:06:43 +01:00
c57a1c76d7
bpo-39971: Change examples to be runnable (GH-32172)
2022-06-25 21:51:26 +01:00
f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853)
2022-06-21 20:55:18 +02:00
e974b3e333
Improve logging documentation with example and additional cookbook re… (GH-93644)
2022-06-09 16:43:35 +01:00
a5ba0f4ebc
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791)
2022-06-09 15:55:06 +02:00
296081a7ce
gh-92592: Allow logging filters to return a LogRecord. (GH-92591)
2022-06-07 16:53:57 +01:00
132e563703
[doc] Improve discoverability of links between logging documents. (GH-93405)
2022-06-01 08:29:13 +01:00
e6e81602f4
[doc] logging.rst - Change link to point directly to the Google Group. (GH-93390)
2022-05-31 22:46:52 +01:00
cc377063ef
gh-91513: Add 'asyncio' taskName to logging LogRecord attributes. (GH-93193)
2022-05-26 09:30:51 +01:00
2176898308
gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063)
2022-05-23 20:18:43 +01:00
3e3e8976b8
bpo-9182: Add a section on specifying positional arguments ( #31810 )
2022-05-13 09:17:07 -05:00
664aa94b57
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>
2022-05-13 14:10:16 +02:00
f9c9354a7a
gh-92536: PEP 623: Remove wstr and legacy APIs from Unicode (GH-92537)
2022-05-12 14:48:38 +09: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
Erlend E. Aasland
Daniele Procida
Eric Snow
Serhiy Storchaka
Hakan Celik
wulmer
Tomas R
Nikita Sobolev
Victor Stinner
Mathieu Dupuy
gsallam
Erlend E. Aasland
Hugo van Kemenade
Rafael Fontenelle
Raymond Hettinger
Ethan Furman
AN Long
Boris Verkhovskiy
Matěj Cepl
VMan
Peter Jiping Xie
Vladimir Malinovskii
Mariusz Felisiak
Yao-Ching Huang
MonadChains
Stanley
Bruno Neyra
Skip Montanaro
Vinay Sajip
partev
Shantanu
Géry Ogam
Adam Turner
Tshepang Mbambo
Pablo Galindo Salgado
Clemens Tolboom
Noam Cohen
Petr Viktorin
Ned Batchelder
Oleg Iarygin
CAM Gerlach
Adrian Garcia Badaracco
Moshe Kaplan
jackh-ncl
Nicolas Haller
Julien Palard
Inada Naoki
Carl Meyer