mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 02:38:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15
116638 commits 6 branches 635 tags 6 GiB
Commit graph

12244 commits

Author SHA1 Message Date
Jürgen Gmach
61f338a005
GH-101112: Specify type of pattern for Path.rglob (#101132) 
The documentation for `rglob` did not mention what `pattern` actually
is.

Mentioning and linking to `fnmatch` makes this explicit, as the
documentation for `fnmatch` both shows the syntax and some explanation.
 2023-01-20 23:11:31 +01:00
Simon Robinson
73497690b5
Fix minor typos in SSL documentation (#101158) 2023-01-20 23:08:45 +01:00
Shantanu
783d1bc51b
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (#101177) 2023-01-20 23:06:10 +01:00
richardhob
3fa8fe7177
gh-88324: Clarify documentation for redirected stdout/stderr when using subprocess in Linux (#94035) 
* Update description of stdout, stderr, and stdin.

Changes:
- Move the ``None`` option (which is default) to the front of the list
  of input options
- Move the ``None`` option description up to make the default behavior
  more clear (No redirection)
- Remove mention of Child File Descriptors from ``None`` option description
 2023-01-19 23:56:13 -08:00
Gregory P. Smith
5927013e47
gh-101144: Allow open and read_text encoding to be positional. (#101145) 
The zipfile.Path open() and read_text() encoding parameter can be supplied as a positional argument without causing a TypeError again. 3.10.0b1 included a regression that made it keyword only.

Documentation update included as users writing code to be compatible with a wide range of versions will need to consider this for some time.
 2023-01-19 23:04:30 -08:00
Nikita Sobolev
9e025d305f
gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) 
* gh-101100: [Enum] Fix sphinx warnings in 

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
 2023-01-19 18:16:21 -08:00
Erlend E. Aasland
b84be8d9c0
Docs: improve sqlite3 placeholders example (#101092) 2023-01-18 10:36:17 +01:00
Viicos
c5660ae96f
Fix typo in ReprEnum documentation (#101079) 2023-01-17 16:21:56 +05:30
Mark Shannon
7b14c2ef19
GH-100982: Add COMPARE_AND_BRANCH instruction (GH-100983) 2023-01-16 12:35:21 +00:00
Oleg Iarygin
8e9d08b062
gh-101041: Fix a misspelled name of utctimetuple in a doc warning (GH-101042) 2023-01-15 12:36:31 -08:00
Cristián Maureira-Fredes
5e9df888dd
Fix ctypes typo in set_exception (#101040) 2023-01-15 20:42:37 +05:30
Erlend E. Aasland
206f05a46b
gh-100668: Clarify how sqlite3 maps parameters onto placeholders (#100960) 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
 2023-01-14 23:58:06 +01:00
Bob Kline
49cae39ef0
gh-101021: Document binary parameters as bytes (#101024) 2023-01-14 11:01:27 -08:00
JustAnotherArchivist
ef633e5000
Sync-up parameter name in equivalent code snippet of enumerate (GH-101029) 2023-01-13 23:55:35 -06:00
Raymond Hettinger
6bde3d2fd3
Add recipes to showcase tee(), zip*, batched, starmap, and product. (GH-101023) 2023-01-13 19:01:22 -06:00
Raymond Hettinger
010576c6ea
Fix typo in docs (GH-101025) 2023-01-13 18:53:06 -06:00
Serhiy Storchaka
e5bd5ad70d
gh-100160: Restore and deprecate implicit creation of an event loop (GH-100410) 
Partially revert changes made in GH-93453.

asyncio.DefaultEventLoopPolicy.get_event_loop() now emits a
DeprecationWarning and creates and sets a new event loop instead of
raising a RuntimeError if there is no current event loop set.

Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
 2023-01-13 14:40:29 +02:00
Steve Dower
b5d4347950
gh-86682: Adds sys._getframemodulename as an alternative to using _getframe (GH-99520) 
Also updates calls in collections, doctest, enum, and typing modules to use _getframemodulename first when available.
 2023-01-13 11:31:06 +00:00
Matthieu Dartiailh
eecd422d1b
gh-96461: Improve docs for bytecode instructions (GH-96462) 
* Clarify the meaning of the oparg for CACHE and COPY opcode in dis doc

* Use STACK to describe stack operation in analogy with a Python list

* Remove (delta) from BEFORE_WITH since BEFORE_WITH does not take an argument

* Fix the description of the stack impact of multiple opcodes
 2023-01-12 18:23:50 +00:00
Noam Cohen
2161bbf243
Fix typo in enum module documentation (#100992) 2023-01-12 21:10:29 +05:30
ram vikram singh
d9dff4c8b5
GH-100894: Updated the doc for sys.winver to clarify its usual contents (GH-100913) 2023-01-12 00:11:12 +00:00
Mariusz Felisiak
847d7708ba
gh-98763: Prefer "python" over "python3" for command line examples in docs. (#98761) 2023-01-11 15:35:41 +05:30
Semen Zhydenko
35650f2538
Fix typos in Doc folder (#100880) 2023-01-10 11:04:06 +02:00
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