thread: add note in docstring

7f1a6a84 · Denis Bilenko · 978e14bc · 7f1a6a84
Commit 7f1a6a84 authored Jul 15, 2010 by Denis Bilenko
Hide whitespace changes
Inline Side-by-side

Showing with 9 additions and 1 deletion

gevent/thread.py gevent/thread.py +9 -1

No files found.
--- a/gevent/thread.py
+++ b/gevent/thread.py
-"""Implementation of the standard :mod:`thread` module that spawns greenlets"""
+"""Implementation of the standard :mod:`thread` module that spawns greenlets.
+
+.. note::
+    
+    This module is a helper for :mod:`gevent.monkey` and is not intended to be
+    used directly. For spawning greenlets in your applications, prefer
+    :class:`Greenlet` class.
+"""
+
 __thread = __import__('thread')
 from gevent.hub import getcurrent, GreenletExit
 from gevent.greenlet import Greenlet