mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-01 06:28:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Touch up docs for ctypes.FormatError & WinError (GH-127210)

Browse source 
Reformat paragraphs, add backquotes, and directives.
This commit is contained in:
Jun Komoda 2024-11-29 00:59:47 +09:00 • committed by GitHub
parent db5c5763f3
commit 49fee592a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/library/ctypes.rst
View file

@ -2035,9 +2035,9 @@ Utility functions
.. function:: FormatError([code]) .. function:: FormatError([code])
Returns a textual description of the error code *code*. If no Returns a textual description of the error code *code*. If no error code is
error code is specified, the last error code is used by calling the Windows specified, the last error code is used by calling the Windows API function
api function GetLastError. :func:`GetLastError`.
.. availability:: Windows .. availability:: Windows
@ -2142,9 +2142,8 @@ Utility functions
.. function:: WinError(code=None, descr=None) .. function:: WinError(code=None, descr=None)
This function is probably the worst-named thing in ctypes. It Creates an instance of :exc:`OSError`. If *code* is not specified,
creates an instance of :exc:`OSError`. If *code* is not specified, :func:`GetLastError` is called to determine the error code. If *descr* is not
``GetLastError`` is called to determine the error code. If *descr* is not
specified, :func:`FormatError` is called to get a textual description of the specified, :func:`FormatError` is called to get a textual description of the
error. error.