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
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
Peter Jiping Xie
Vladimir Malinovskii
Mariusz Felisiak
Yao-Ching Huang
MonadChains
Stanley
Ethan Furman
Bruno Neyra
Skip Montanaro
Vinay Sajip
partev
Erlend E. Aasland
Raymond Hettinger
Shantanu
Géry Ogam
Nikita Sobolev
Hugo van Kemenade
Adam Turner
Tshepang Mbambo
Victor Stinner
Serhiy Storchaka
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
Mathieu Dupuy
Mike cm
Dave Goncalves
Yuxin Wu
Alex-Blade
Manish Kumar ⛄
Piotr Fusik
Kumar Aditya
Alex Waygood
Guido van Rossum
DonnaDia
Rohit Nishad
Elliot Waite
E-Paine
krisaoe
larryhastings
Andre Delfino
Zackery Spytz
Harry