[Python-checkins] [3.12] gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769) (#108163)
Yhg1s
webhook-mailer at python.org
Sun Aug 20 09:50:12 EDT 2023
https://github.com/python/cpython/commit/590bc6a226f6425970197ff5c3a57beeaa99cdca
commit: 590bc6a226f6425970197ff5c3a57beeaa99cdca
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Yhg1s <thomas at python.org>
date: 2023-08-20T15:50:09+02:00
summary:
[3.12] gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769) (#108163)
gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769)
(cherry picked from commit beffb30dc7a07044f4198245d049ddda1f4b24db)
Co-authored-by: Tomas R <tomas.roun8 at gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya at python.org>
files:
M Doc/library/ctypes.rst
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index cd5c41e9b59c9..19cee10711fb8 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -2029,17 +2029,17 @@ Utility functions
specifying an address, or a ctypes instance.
-.. function:: POINTER(type)
+.. function:: POINTER(type, /)
- This factory function creates and returns a new ctypes pointer type. Pointer
- types are cached and reused internally, so calling this function repeatedly is
- cheap. *type* must be a ctypes type.
+ Create and return a new ctypes pointer type. Pointer types are cached and
+ reused internally, so calling this function repeatedly is cheap.
+ *type* must be a ctypes type.
-.. function:: pointer(obj)
+.. function:: pointer(obj, /)
- This function creates a new pointer instance, pointing to *obj*. The returned
- object is of the type ``POINTER(type(obj))``.
+ Create a new pointer instance, pointing to *obj*.
+ The returned object is of the type ``POINTER(type(obj))``.
Note: If you just want to pass a pointer to an object to a foreign function
call, you should use ``byref(obj)`` which is much faster.
More information about the Python-checkins
mailing list