diff options
| author | Shreyan Avigyan <shreyan.avigyan@gmail.com> | 2024-04-18 14:57:37 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-18 14:57:37 (GMT) |
| commit | 81a926bd20a8c66646e51b66ef1cfb309b73ebe7 (patch) | |
| tree | 1257615e408bfb8ee55c6336d089a0acaed02132 | |
| parent | 340a02b590681d4753eef0ff63037d0ecb512271 (diff) | |
| download | cpython-81a926bd20a8c66646e51b66ef1cfb309b73ebe7.zip cpython-81a926bd20a8c66646e51b66ef1cfb309b73ebe7.tar.gz cpython-81a926bd20a8c66646e51b66ef1cfb309b73ebe7.tar.bz2 | |
gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (#25384)
The implementation uses 'ptr' for the name of the first parameter of
ctypes.string_at() and ctypes.wstring_at(). Align docs and docstrings
with the naming used in the implementation.
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
| -rw-r--r-- | Doc/library/ctypes.rst | 16 | ||||
| -rw-r--r-- | Lib/ctypes/__init__.py | 8 |
2 files changed, 12 insertions, 12 deletions
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst index 9f7d645..1deaa3a 100644 --- a/Doc/library/ctypes.rst +++ b/Doc/library/ctypes.rst @@ -2077,13 +2077,13 @@ Utility functions Does the same as the C ``sizeof`` operator. -.. function:: string_at(address, size=-1) +.. function:: string_at(ptr, size=-1) - This function returns the C string starting at memory address *address* as a bytes - object. If size is specified, it is used as size, otherwise the string is assumed + Return the byte string at *void \*ptr*. + If *size* is specified, it is used as size, otherwise the string is assumed to be zero-terminated. - .. audit-event:: ctypes.string_at address,size ctypes.string_at + .. audit-event:: ctypes.string_at ptr,size ctypes.string_at .. function:: WinError(code=None, descr=None) @@ -2099,14 +2099,14 @@ Utility functions alias of :exc:`OSError`. -.. function:: wstring_at(address, size=-1) +.. function:: wstring_at(ptr, size=-1) - This function returns the wide character string starting at memory address - *address* as a string. If *size* is specified, it is used as the number of + Return the wide-character string at *void \*ptr*. + If *size* is specified, it is used as the number of characters of the string, otherwise the string is assumed to be zero-terminated. - .. audit-event:: ctypes.wstring_at address,size ctypes.wstring_at + .. audit-event:: ctypes.wstring_at ptr,size ctypes.wstring_at .. _ctypes-data-types: diff --git a/Lib/ctypes/__init__.py b/Lib/ctypes/__init__.py index 36b2af7..b7ee46d 100644 --- a/Lib/ctypes/__init__.py +++ b/Lib/ctypes/__init__.py @@ -534,9 +534,9 @@ def cast(obj, typ): _string_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_string_at_addr) def string_at(ptr, size=-1): - """string_at(addr[, size]) -> string + """string_at(ptr[, size]) -> string - Return the string at addr.""" + Return the byte string at void *ptr.""" return _string_at(ptr, size) try: @@ -546,9 +546,9 @@ except ImportError: else: _wstring_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_wstring_at_addr) def wstring_at(ptr, size=-1): - """wstring_at(addr[, size]) -> string + """wstring_at(ptr[, size]) -> string - Return the string at addr.""" + Return the wide-character string at void *ptr.""" return _wstring_at(ptr, size) |