Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-31 04:23:37 +00:00
Code Issues Projects Releases Packages Wiki Activity
112490 commits 6 branches 641 tags 3.6 GiB
Commit graph

1272 commits

Author SHA1 Message Date
Eric Snow
917439d4d9
[3.10] gh-98154: Clarify Usage of "Reference Count" In the Docs (#107754) 2023-08-11 13:41:56 +00:00
Miss Islington (bot)
f12502b2b3
[3.10] gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105185) (#105220) 
(cherry picked from commit ee26ca13a1)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
 2023-06-05 18:06:43 +02:00
Hugo van Kemenade
7513c6b6fe
[3.10] gh-101100: Document PyObject_ClearWeakRefs and gzip's name (#103002) 2023-03-25 09:44:05 +02:00
Miss Islington (bot)
eaafea86a0
gh-102595: Document PyObject_Format c-api function (GH-102596) 
(cherry picked from commit 910a64e301)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
 2023-03-22 02:32:08 -07:00
Miss Islington (bot)
bef189b5c7
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695) 
(cherry picked from commit 61b9ff35cb)

Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
 2023-03-15 15:14:00 -07:00
Miss Islington (bot)
7d2ad478d1
Fix typo in Py_GetPythonHome signature (GH-102168) 
(cherry picked from commit 9bba8035bd)

Co-authored-by: Tanner Firl <105078804+TannerFirl@users.noreply.github.com>
 2023-02-23 05:37:24 -08:00
Miss Islington (bot)
f4f5dd5c39
gh-101973: Fix parameter reference for PyModule_FromDefAndSpec (GH-101976) 
(cherry picked from commit a3bb7fbe7e)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
 2023-02-17 00:51:24 -08:00
Miss Islington (bot)
bc3718eb4b
GH-101898: Fix missing term references for hashable definition (GH-101899) 
Fix missing term references for hashable definition
(cherry picked from commit 3690688149)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
 2023-02-14 02:47:49 -08:00
Miss Islington (bot)
a259efc63f
[docs] Mention how to get/set a bigint PyLong via the C API (GH-101270) 
We don't need direct C APIs to get at a bigint representation of PyLong but we
do want the few people who need to understand how.

Additional Author:  CAM-Gerlach
(cherry picked from commit e244401ce5)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
 2023-01-23 21:30:29 -08:00
Miss Islington (bot)
8b023134bd
docs: fix ssizeobjargproc parameters (GH-100736) 
(cherry picked from commit 5fb1c08e15)

Co-authored-by: David Lechner <david@lechnology.com>
 2023-01-04 07:36:44 -08:00
Miss Islington (bot)
bd472198c6
gh-98712: Clarify "readonly bytes-like object" semantics in C arg-parsing docs (GH-98710) 
(cherry picked from commit 49f6ff719c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
 2022-12-23 07:09:34 -08:00
Miss Islington (bot)
e38a525c20
gh-97909: Fix markup for PyMethodDef members (GH-100089) 
(cherry picked from commit 8edcb30c3f)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
 2022-12-16 23:19:54 -08:00
Miss Islington (bot)
b1c148c1be
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) 
These slots are marked "should be treated as read-only" in the
table at the start of the document.  That doesn't say anything about
setting them in the static struct.

`tp_bases` docs did say that it should be ``NULL`` (TIL!). If you
ignore that, seemingly nothing bad happens. However, some slots
may not be inherited, depending on which sub-slot structs are present.
(FWIW, NumPy sets tp_bases and is affected by the quirk -- though to
be fair, its DUAL_INHERIT code probably predates tp_bases docs, and
also the result happens to be benign.)

This patch makes things explicit.
It also makes the summary table legend easier to scan.

(cherry picked from commit 219696abb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
 2022-11-28 03:26:05 -08:00
Miss Islington (bot)
731a747a91
Doc: Replace question mark with fullstop (GH-99558) 
The sentence "Set the LC_CTYPE locale to the user preferred locale." should end with a period
instead of a question mark.
(cherry picked from commit 0e09d2cc59)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
 2022-11-18 11:34:17 -08:00
Miss Islington (bot)
d2cb0f9117
[3.10] gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION inheritance (GH-99002) (GH-99213) 
gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION inheritance (GH-99002)

The flag is not inherited, but its effect -- a NULL tp_new -- is.

Drop hints for people who come here wanting to “disallow instantiation”.
(cherry picked from commit 1438b77997)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
 2022-11-07 19:56:21 +01:00
Miss Islington (bot)
6cf30c6cc4
gh-96997: Clarify the contract of PyMem_SetAllocator() (GH-98977) 
(cherry picked from commit c053284e39)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
 2022-11-02 14:56:14 -07:00
C.A.M. Gerlach
b2db1c2080
[3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373) 
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:47 +02:00
Miss Islington (bot)
03ea515f33
Fix types in buffer/memoryview docs (GH-98118) 
The definition of obj in the `Py_buffer` struct is as a PyObject*
ec091bd47e/Include/pybuffer.hGH-L22

PyMemoryView_GET_BASE returns `.obj` - thus its return type
should be a PyObject* (or at least a void*). It definitely
doesn't return `Py_buffer`
(cherry picked from commit c459fedf7c)

Co-authored-by: da-woods <dw-git@d-woods.co.uk>
 2022-10-09 18:02:49 -07:00
Miss Islington (bot)
90f2c7992f
Add a warning message about PyOS_snprintf (GH-95993) 
(cherry picked from commit c7b2204996)

Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
 2022-10-07 13:36:21 -07:00
Łukasz Langa
537c93ea3b
[3.10] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97977) 
Also, disable using invalid sphinx-lint 0.6.2.
(cherry picked from commit f612565bd3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-06 11:56:52 -07:00
Łukasz Langa
3b0f2a7ff0
[3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 
:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 14:10:55 -07:00
Miss Islington (bot)
b39182e4b0
[3.10] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97911) 
(cherry picked from commit 0e72606dd4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
 2022-10-05 11:00:50 -07:00
Miss Islington (bot)
de0a656d5b
[3.10] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97890) 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit c70c8b6976)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 08:21:18 -07:00
Łukasz Langa
9aed6bdb20
[3.10] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97893) 
Use `c:struct`
(cherry picked from commit a0f5599aac)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 08:20:46 -07:00
Łukasz Langa
d99ea4c7a2
[3.10] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) (GH-97775) (#97891) 
(cherry picked from commit 6b3d4db02e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 08:19:38 -07:00
Miss Islington (bot)
4245764fae
[3.10] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97888) 
:c:type:`PyObject` -> :c:expr:`PyObject`
(cherry picked from commit 0bf6a617ed)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 08:17:46 -07:00
Miss Islington (bot)
09e5029aca
[3.10] gh-93738: Documentation C syntax (:c:type:PyInterpreterState * -> :c:expr:PyInterpreterState *) (GH-97777) (#97877) 
:c:type:`PyInterpreterState *` -> :c:expr:`PyInterpreterState *`
(cherry picked from commit 4ebb025031)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 17:56:46 -07:00
Miss Islington (bot)
95289bf983
[3.10] gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) (GH-97773) (#97868) 
:c:data:`view->obj` -> :c:expr:`view->obj`
(cherry picked from commit fa59bda8d3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 17:55:31 -07:00
Miss Islington (bot)
994eaa3a6f
[3.10] gh-93738: Documentation C syntax (:c:type:TYPE -> :c:expr:TYPE) (GH-97770) (#97870) 
:c:type:`TYPE` -> :c:expr:`TYPE`
(cherry picked from commit 8b211b4cdb)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 17:47:56 -07:00
Miss Islington (bot)
5eedf1d863
[3.10] gh-93738: Documentation C syntax (:c:type:FILE -> :c:expr:FILE) (GH-97769) (#97872) 
:c:type:`FILE` -> :c:expr:`FILE`
(cherry picked from commit 192d401ba5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 17:47:20 -07:00
Miss Islington (bot)
9c755d7d6b
[3.10] gh-93738: Documentation C syntax (:c:type:PyTupleObject* -> :c:expr:PyTupleObject*) (GH-97780) (#97864) 
:c:type:`PyTupleObject*` -> :c:expr:`PyTupleObject*`
(cherry picked from commit 510baa429a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 16:46:30 -07:00
Miss Islington (bot)
5aa108b9e0
[3.10] gh-93738: Documentation C syntax (:c:type:PyBytesObject* -> :c:expr:PyBytesObject*) (GH-97782) (#97862) 
:c:type:`PyBytesObject*` -> :c:expr:`PyBytesObject*`
(cherry picked from commit 9ebc50866b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 16:41:05 -07:00
Miss Islington (bot)
20ddf1c17a
[3.10] gh-93738: Documentation C syntax (:c:type:PyUnicodeObject* -> :c:expr:PyUnicodeObject*) (GH-97783) (#97860) 
:c:type:`PyUnicodeObject*` -> :c:expr:`PyUnicodeObject*`
(cherry picked from commit 898834e27b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-04 16:39:57 -07:00
Miss Islington (bot)
82ce586f10
gh-93738: Documentation C syntax (:c:data:0 -> `0`) (GH-97771) 
:c:data:`0` -> ``0``
(cherry picked from commit 5e997cff3e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-03 18:55:08 -07:00
Miss Islington (bot)
e89f8b0ae4
Doc: Update Py_TPFLAGS_HAVE_FINALIZE in docs (GH-96273) 
It is now deprecated and the docs should reflect that.
(cherry picked from commit 9625de6fab)

Co-authored-by: da-woods <dw-git@d-woods.co.uk>
 2022-08-30 01:38:53 -07:00
Miss Islington (bot)
2f88289cf5
Clarify API stability of PyTypeObject in relation to static types. (GH-96217) 
Fixes:
https://github.com/python/cpython/issues/95300

Related:
https://github.com/python/cpython/issues/91271
(cherry picked from commit caa2a9799a)

Co-authored-by: ov2k <ov2k.github@gmail.com>
 2022-08-25 06:42:32 -07:00
Miss Islington (bot)
8a01502e2d
gh-90359: Unify documentation style for datetime.rst (gh-94836) 
(cherry picked from commit 967da5febb)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
 2022-07-13 17:51:03 -07:00
Miss Islington (bot)
381b86bde8
gh-90359: Update documentation to follow PEP 495. (gh-94800) 
(cherry picked from commit 07374cce52)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
 2022-07-13 17:16:44 -07:00
Łukasz Langa
6e47020d31
[3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558) 
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
 2022-07-05 14:30:37 +02:00
Miss Islington (bot)
3473a128d1
[doc] fix typo in reference to tp_descr_get and tp_descr_set (GH-94140) 
(cherry picked from commit 32d595fdcd)

Co-authored-by: Max Bachmann <kontakt@maxbachmann.de>
 2022-06-26 03:11:43 -07:00
Miss Islington (bot)
5b2ad48431
gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) (GH-93605) 
Nowadays everything that *is* in the Limited API has a note added
automatically.
These notes could mislead people to think that these functions
could never be added to the limited API. Remove them.

(cherry picked from commit 2c3fe5eeb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
 2022-06-10 16:04:47 +02:00
Miss Islington (bot)
2139583bf9
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93639) 
(cherry picked from commit a5ba0f4ebc)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
 2022-06-09 16:15:49 +02:00
Miss Islington (bot)
1815d8e64f
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805) 
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28039)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
 2022-05-18 02:00:00 -07:00
Miss Islington (bot)
48f2d8de24
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>
(cherry picked from commit 664aa94b57)

Co-authored-by: Julien Palard <julien@palard.fr>
 2022-05-13 06:32:39 -07:00
Miss Islington (bot)
f40731fb51
[3.10] GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432) (GH-92470) 
* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54bc9)


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

Automerge-Triggered-By: GH:serhiy-storchaka
 2022-05-08 08:28:47 -07:00
Miss Islington (bot)
229dc17f7a
gh-92047: Py_GetVersion multi-digit minor version (GH-92047) (GH-92048) (#92330) 
(cherry picked from commit 43b135f94e)

Co-authored-by: Robert Howlett <robert@howletts.org.uk>

Co-authored-by: Robert Howlett <robert@howletts.org.uk>
 2022-05-06 14:47:09 +02:00
Miss Islington (bot)
367faf71ea
Document the lifetime of PyUnicode_AsUTF8String (GH-92325) 
The current wording implied this, but didn't state it explicitly.
(cherry picked from commit 740da8d37a)

Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
 2022-05-06 02:55:01 -07:00
Oleg Iarygin
e7e8a9fa4f
[3.10] gh-91118: Fix docstrings that do not honor --without-doc-strings (GH-31769) (#91662) 
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a573cb2fec)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
 2022-04-19 13:01:09 -07:00
Miss Islington (bot)
b4abef2295
c-api docs: There are five fields, not four (GH-32379) 
(cherry picked from commit 4c92427fb8)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
 2022-04-07 07:27:40 -07:00
Jelle Zijlstra
11f5fd1135
[3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 
* wording fixes in type.rst

* grammar and punctuation in sys.rst

* set: grammar fixes

* structures: capitalization fix

* grammar fixes for sequence

* objects: point to Py_TYPE instead of direct object access

* numbers: add more explicit Python equivalences

* method: add missing period

* memory: grammar fix

* mapping: grammar fixes

* long: grammar fix

* iter: fix grammar for PyAIter_Check

* init: grammar fix.
(cherry picked from commit 897bc6f928)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
 2022-04-02 16:00:51 -07:00