Ryan Ozawa
e098137cd3
bpo-28356: Document os.rename() behavior on Windows for differing volumes (GH-27376)
2023-01-09 21:43:09 +00:00
dsentinel
7a50d6b5b0
GH-100813: Add `socket.IP_PKTINFO` constant ( #10294 )
2023-01-09 14:30:40 +05:30
Shantanu
53455a319f
gh-100783: fix os.path.join documentation ( #100811 )
...
- Use "drive", not "drive letter", because of UNC paths
- Previous components are not thrown away from relative drive letters
- Use "segment" instead of "component" for consistency with pathlib
- Other miscellaneous improvements
2023-01-08 00:51:30 -08:00
busywhitespace
6d3bc4a795
gh-100824: Fix typo in the documentation of unittest.TestLoader.testNamePatterns ( #100825 )
2023-01-08 13:37:16 +05:30
Raymond Hettinger
47b9f83a83
GH-100485: Add math.sumprod() (GH-100677)
2023-01-07 12:46:35 -06:00
FrozenBob
deaf090699
gh-100673: Removed erroneous note in the get_type_hints docs ( #100701 )
...
Removed erroneous note in the get_type_hints docs
typing.get_type_hints still includes base class type hints.
2023-01-07 17:31:47 +00:00
Mark Shannon
78068126a1
GH-99005: More intrinsics (GH-100774)
...
* Remove UNARY_POSITIVE, LIST_TO_TUPLE and ASYNC_GEN_WRAP, replacing them with intrinsics.
2023-01-06 14:47:57 +00:00
Akshit Tyagi
659c2607f5
gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)
...
update dataclasses docs for when annotations are inspected
2023-01-06 09:26:44 -05:00
Shantanu
2f2fa03ff3
gh-87691: clarify use of anchor in pathlib docs ( #100782 )
...
This is feedback from https://github.com/python/cpython/pull/100737#discussion_r1062968696
This matches the wording from the `os.path.join` docs better:
https://docs.python.org/3/library/os.path.html#os.path.join
In particular, the previous use of "anchor" was incorrect given the
pathlib definition of "anchor".
Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-05 17:49:33 -08:00
Shantanu
1ae619c911
gh-87691: add an absolute path pathlib example in / operator docs (GH-100737)
...
The behaviour is fully explained a couple paragraphs above, but it may be useful to have a brief example to cover the behaviour.
Automerge-Triggered-By: GH:hauntsaninja
2023-01-05 14:55:35 -08:00
Mark Shannon
28187141cc
GH-99005: Add `CALL_INTRINSIC_1` instruction (GH-100771)
...
* Remove PRINT_EXPR instruction
* Remove STOPITERATION_ERROR instruction
* Remove IMPORT_STAR instruction
2023-01-05 16:05:51 +00:00
Tzu-ping Chung
105e37395d
GH-100766: Note that locale.LC_MESSAGES is not universal (GH-100702)
2023-01-05 03:34:30 +00:00
Ethan Furman
a286caa937
gh-91219: http - use subclassing to override index_pages attribute (GH-100731)
...
Remove previously added parameter to `__init__`, and recommend subclassing to modify the `index_pages` attribute instead.
2023-01-03 15:20:08 -08:00
Christophe Nanteuil
64ed609c53
[Enum] docs: replace 'last value' by 'highest value' for Flag auto (GH-100709)
2023-01-03 14:08:50 -08:00
Shantanu
edfbf56f4c
gh-100428: Make int documentation more accurate ( #100436 )
...
- Remove first link to lexical definition of integer literal, since it
doesn't apply (differs in handling of leading zeros, base needs to be
explicitly specified, unicode digits are allowed)
- Better describe handling of leading zeros, unicode digits, underscores
- Base 0 does not work exactly as like a code literal, since it allows
Unicode digits. Link code literal to lexical definition of integer
literal.
2023-01-01 19:14:18 -08:00
Erlend E. Aasland
b7a68ab824
gh-99953: Purge mention of numeric param style from sqlite3 docs ( #100630 )
...
The PEP-249 numeric style has never been supported by sqlite3.
2023-01-01 23:26:23 +01:00
Jason R. Coombs
447d061bc7
gh-97930: Apply changes from importlib_resources 5.10. (GH-100598)
2023-01-01 11:07:32 -05:00
Mehrdad Moradizadeh
1d1480fefc
gh-96773 Fix documentation of socket backlog ( #96778 )
2023-01-01 20:36:17 +05:30
Shantanu
e83f88a455
gh-100488: Add is_integer method to fractions.Fraction ( #100489 )
2023-01-01 01:44:48 -07:00
Shantanu
71159a8e07
gh-100546: Remove incorrect positional-only marker from eval ( #100547 )
...
All the arguments are positional-only.
The current status after #99476 seems to be to not use positional-only
markers in documentation, hence I've simply removed it.
2022-12-31 17:59:31 -07:00
Sandeep Subramanian
ac7a0a9f9e
GH-87002: fix caching documentation in `struct` module ( #24164 )
2022-12-31 22:27:58 +05:30
Raymond Hettinger
4ebaae8aed
Improve comments in itertools uniquification recipes (GH-100631)
2022-12-30 20:36:38 -06:00
mathieui
f4fcfdf8c5
gh-100616: Document 'attr' parameter for window.vline() in curses module ( #24961 )
...
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-30 08:35:04 -08:00
ram vikram singh
7223d50b97
gh-100583: Improve the `pydoc` documentation ( #100590 )
2022-12-29 20:47:20 +05:30
JustAnotherArchivist
cf1c098180
GH-100101: Clarify documentation of zip's strict option (GH-100103)
2022-12-28 13:24:50 -08:00
Raymond Hettinger
c4c5790120
Restore early-out to factor(). Strengthen tests. (GH-100591)
2022-12-28 12:29:27 -08:00
Hugo van Kemenade
9eca7235af
gh-94172: Update docs for params removed in 3.12 ( #100431 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-28 14:43:19 -05:00
Raymond Hettinger
2d52406835
Improve factor() recipe and fix its tests (GH-100576)
2022-12-28 03:13:58 -08:00
Guy Yagev
ad3c99e521
gh-92446: Improve argparse choices docs; revert bad change to lzma docs ( #94627 )
...
Based on the definition of the collections.abc classes, it is more accurate to use "sequence" instead of "container" when describing argparse choices.
A previous attempt at fixing this in #92450 was mistaken; this PR reverts that change.
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-26 00:22:53 -06:00
Ilya Kulakov
dbc1e696eb
gh-99308: Clarify re docs for byte pattern group names ( #99311 )
2022-12-25 12:25:27 +05:30
Shantanu
046cbc2080
gh-100472: Fix docs claim that compileall parameters could be bytes ( #100473 )
2022-12-24 14:22:49 -06:00
Bart Broere
efccd04b9e
[Minor PR] Quotes in documentation changed into code blocks ( #99536 )
...
Minor formatting fix in documentation
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:17:39 -08:00
Shantanu
2e1a9ce989
gh-100428: Make float documentation more accurate ( #100437 )
...
Previously, the grammar did not accept `float("10")`.
Also implement mdickinson's suggestion of removing the indirection.
2022-12-24 14:09:31 -06:00
MonadChains
f5b7b19bf1
gh-99535: Add test for inheritance of annotations and update documentation ( #99990 )
2022-12-24 12:07:14 -08:00
Raymond Hettinger
0769f95751
Misc Itertools recipe tweaks (GH-100493)
2022-12-24 00:21:30 -08:00
Stanley
0f6420640c
gh-77771: Add enterabs example in sched ( #92716 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-23 23:21:52 -06:00
Shantanu
3e46f9fe05
gh-100268: Add is_integer method to int ( #100439 )
...
This improves the lives of type annotation users of `float` - which type checkers implicitly treat as `int|float` because that is what most code actually wants. Before this change a `.is_integer()` method could not be assumed to exist on things annotated as `: float` due to the method not existing on both types.
2022-12-23 18:30:27 -08:00
Raymond Hettinger
f89de679ff
Add "strict" to dotproduct(). Add docstring. Factor-out common code. (GH-100480)
2022-12-23 15:52:16 -08:00
Raymond Hettinger
5d84966cce
GH-100425: Improve accuracy of builtin sum() for float inputs (GH-100426)
2022-12-23 14:35:58 -08:00
Stanley
c615286e85
gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced entry ( #91499 )
...
Co-authored-by: Pieter Eendebak <P.T.eendebak@tudelft.nl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-20 19:27:02 -08:00
Bisola Olasehinde
a2bb3b7f9d
gh-99991: improve docs on str.encode and bytes.decode ( #100198 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-20 18:02:14 -08:00
Pablo Galindo Salgado
cb60b6131b
Clarify that every thread has its own default context in contextvars ( #99246 )
2022-12-20 11:35:48 +00:00
Brad Wolfe
39dfbb2d5d
gh-88211: Change lower-case and upper-case to match recommendations in imaplib docs ( #99625 )
2022-12-20 15:40:31 +05:30
Thomas Grainger
79ccc03b62
gh-89051: Add ssl.OP_LEGACY_SERVER_CONNECT ( #93927 )
...
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Christian Heimes <christian@python.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Fixes https://github.com/python/cpython/issues/89051
2022-12-20 09:10:30 +02:00
Stanley
36a0b1d0dd
gh-69929: re docs: Add more specific definition of \w ( #92015 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-19 19:07:31 -08:00
Carlton Gibson
532aa4e4e0
gh-94912: Added marker for non-standard coroutine function detection ( #99247 )
...
This introduces a new decorator `@inspect.markcoroutinefunction`,
which, applied to a sync function, makes it appear async to
`inspect.iscoroutinefunction()`.
2022-12-18 11:13:24 -08:00
Jeremy Paige
1cf3d78c92
Correct CVE-2020-10735 documentation ( #100306 )
2022-12-18 12:41:21 +05:30
Barney Gale
5a991da329
gh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (GH-94469)
...
This brings `relative_to()` and `is_relative_to()` more in line with other pathlib methods like `rename()` and `symlink_to()`.
Resolves #78707 .
2022-12-16 16:14:27 -08:00
Ben Darnell
5234e1cbea
gh-99830: asyncio: Document returns of remove_{reader,writer} ( #100302 )
2022-12-16 11:04:55 -08:00
JustAnotherArchivist
5ee7eb9deb
Document that zipfile's pwd parameter is a `bytes` object ( #100209 )
2022-12-16 16:10:10 +05:30