#10741: add documentation for PyGILState_GetThisThreadState()

sandrotosi · sandrotosi · commit 61baee0ee7c5 · 2011-08-08T00:16:54.000+02:00
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
@@ -646,6 +646,14 @@ with sub-interpreters:
    :c:func:`PyGILState_Release` on the same thread.
 
 
+.. c:function:: PyThreadState PyGILState_GetThisThreadState()
+
+   Get the current thread state for this thread.  May return ``NULL`` if no
+   GILState API has been used on the current thread.  Note that the main thread
+   always has such a thread-state, even if no auto-thread-state call has been
+   made on the main thread.  This is mainly a helper/diagnostic function.
+
+
 The following macros are normally used without a trailing semicolon; look for
 example usage in the Python source distribution.
 
diff --git a/Include/pystate.h b/Include/pystate.h
@@ -195,7 +195,7 @@ PyAPI_FUNC(void) PyGILState_Release(PyGILState_STATE);
 
 /* Helper/diagnostic function - get the current thread state for
    this thread.  May return NULL if no GILState API has been used
-   on the current thread.  Note the main thread always has such a
+   on the current thread.  Note that the main thread always has such a
    thread-state, even if no auto-thread-state call has been made
    on the main thread.
 */
