[pypy-commit] pypy gc-hooks: docstring

[antocuni]

Author: Antonio Cuni <anto.cuni at gmail.com>
Branch: gc-hooks
Changeset: r94252:bbdde3a6fc01
Date: 2018-04-05 14:39 +0200
http://bitbucket.org/pypy/pypy/changeset/bbdde3a6fc01/

Log:	docstring

diff --git a/pypy/module/gc/hook.py b/pypy/module/gc/hook.py
--- a/pypy/module/gc/hook.py
+++ b/pypy/module/gc/hook.py
@@ -8,6 +8,15 @@
 from pypy.interpreter.executioncontext import AsyncAction
 
 class LowLevelGcHooks(GcHooks):
+    """
+    These are the low-level hooks which are called directly from the GC.
+
+    They can't do much, because the base class marks the methods as
+    @rgc.no_collect.
+
+    This is expected to be a singleton, created by space.fromcache, and it is
+    integrated with the translation by targetpypystandalone.get_gchooks
+    """
 
     def __init__(self, space):
         self.space = space