From c7627b10bea560ec3503bba7ad14aabd85947917 Mon Sep 17 00:00:00 2001 From: David Halter Date: Wed, 6 Feb 2013 00:08:34 +0100 Subject: [PATCH] recursion docstring --- jedi/recursion.py | 9 +++++++++ jedi/settings.py | 2 ++ 2 files changed, 11 insertions(+) diff --git a/jedi/recursion.py b/jedi/recursion.py index 837c15df..8bc31f1b 100644 --- a/jedi/recursion.py +++ b/jedi/recursion.py @@ -1,3 +1,12 @@ +""" +Recursions are the recipe of |jedi| to conquer Python code. However, someone +must stop recursions going mad. Some settings are here to make |jedi| stop at +the right time. You can read more about them :ref:`here `. + +Next to :mod:`cache` this module also makes |jedi| not thread-safe. Why? +``ExecutionRecursionDecorator`` uses class variables to count the function +calls. +""" import parsing_representation as pr import evaluate_representation as er import debug diff --git a/jedi/settings.py b/jedi/settings.py index 71e5a5ce..9e0f28c4 100644 --- a/jedi/settings.py +++ b/jedi/settings.py @@ -47,6 +47,8 @@ Dynamic stuff .. autodata:: additional_dynamic_modules +.. _settings-recursion: + Recursions ~~~~~~~~~~