From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sat, 22 Oct 2011 21:41:52 +0000 (+0200)
Subject: Add a docstring to SSLError
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a0e0e232993b87fe446f95d6583d947ae01bf517;p=python

Add a docstring to SSLError
---

diff --git a/Modules/_ssl.c b/Modules/_ssl.c
index 36ce33fc53..2998605476 100644
--- a/Modules/_ssl.c
+++ b/Modules/_ssl.c
@@ -2297,6 +2297,10 @@ parse_openssl_version(unsigned long libver,
     *major = libver & 0xFF;
 }
 
+PyDoc_STRVAR(SSLError_doc,
+"An error occurred in the SSL implementation.");
+
+
 PyMODINIT_FUNC
 PyInit__ssl(void)
 {
@@ -2333,9 +2337,10 @@ PyInit__ssl(void)
     OpenSSL_add_all_algorithms();
 
     /* Add symbols to module dict */
-    PySSLErrorObject = PyErr_NewException("ssl.SSLError",
-                                          PyExc_OSError,
-                                          NULL);
+    PySSLErrorObject = PyErr_NewExceptionWithDoc("ssl.SSLError",
+                                                 SSLError_doc,
+                                                 PyExc_OSError,
+                                                 NULL);
     if (PySSLErrorObject == NULL)
         return NULL;
     if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0)