[Python-checkins] gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (#107769)
kumaraditya303
webhook-mailer at python.org
Sun Aug 20 06:54:09 EDT 2023
https://github.com/python/cpython/commit/beffb30dc7a07044f4198245d049ddda1f4b24db
commit: beffb30dc7a07044f4198245d049ddda1f4b24db
branch: main
author: Tomas R <tomas.roun8 at gmail.com>
committer: kumaraditya303 <kumaraditya at python.org>
date: 2023-08-20T10:54:06Z
summary:
gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (#107769)
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 474359a5cd98b..8af609d53ff4b 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