https://github.com/python/cpython/commit/49fee592a4fad17781bb4a78f95085d6edbb24d5
commit: 49fee592a4fad17781bb4a78f95085d6edbb24d5
branch: main
author: Jun Komoda <[email protected]>
committer: encukou <[email protected]>
date: 2024-11-28T16:59:47+01:00
summary:
Touch up docs for ctypes.FormatError & WinError (GH-127210)
Reformat paragraphs, add backquotes, and directives.
files:
M Doc/library/ctypes.rst
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index f490f7563b58a5..bd9529db9ee65a 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -2035,9 +2035,9 @@ Utility functions
.. function:: FormatError([code])
- Returns a textual description of the error code *code*. If no
- error code is specified, the last error code is used by calling the Windows
- api function GetLastError.
+ Returns a textual description of the error code *code*. If no error code is
+ specified, the last error code is used by calling the Windows API function
+ :func:`GetLastError`.
.. availability:: Windows
@@ -2142,9 +2142,8 @@ Utility functions
.. 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,
- ``GetLastError`` is called to determine the error code. If *descr* is not
+ Creates an instance of :exc:`OSError`. If *code* is not specified,
+ :func:`GetLastError` is called to determine the error code. If *descr* is
not
specified, :func:`FormatError` is called to get a textual description of the
error.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
