[issue43803] ctypes string_at/wstring_at - bad argument name used in docs and in docstring

Shreyan Avigyan <shreyan.avigyan@gmail.com> added the comment:
I'd favor updating them all to say "ptr", because changing the name of the runtime parameter would risk breaking users' code.
I also certainly agree with that. Moreover, the documentation and docstring uses the name "address" and "addr" respectively which are misleading because it is asking for ctypes.c_char_p or ctypes.c_wchar_p which are C pointer types, it is not asking for the address of instances of ctypes.c_char_p or ctypes.c_wchar_p. Therefore a change in the documentation and docstring is required. Note - If this issue is confirmed then I'll submit a PR to apply the change as described in this issue. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, shreyanavigyan title: ctypes string_at/wstring_at bad argument name -> ctypes string_at/wstring_at - bad argument name used in docs and in docstring _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43803> _______________________________________
participants (1)
-
Shreyan Avigyan