Modules/socketmodule.c: better comment for internal_connect

korli · encukou · web-flow · commit 49cf089b48c7 · 2024-09-06T12:02:24.000+02:00
Co-authored-by: Petr Viktorin &lt;encukou@gmail.com&gt;
diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c
@@ -3405,7 +3405,18 @@ sock_connect_impl(PySocketSockObject *s, void* Py_UNUSED(data))
     return 1;
 }
 
-/* Returns 0 on success, -1 with exception set on failure, or error code if not. */
+/* Common functionality for socket.connect and socket.connect_ex.
+ *
+ * If *raise* is set:
+ * - On success, return 0.
+ * - On any failure, return -1 with an exception set.
+ * If *raise* is zero:
+ * - On success, return 0.
+ * - On connect() failure, return errno (without an exception set)
+ * - On other error, return -1 with an exception set.
+ *
+ *   Note that -1 is a valid errno value on some systems.
+ */
 static int
 internal_connect(PySocketSockObject *s, struct sockaddr *addr, int addrlen,
                  int raise)
