refactoring docstring

2013-02-05 23:25:39 +01:00
parent cd931c5112
commit 12d9d5b9fd
1 changed files with 13 additions and 1 deletions
--- a/jedi/refactoring.py
+++ b/jedi/refactoring.py
@@ -1,4 +1,16 @@
-""" Introduce refactoring """
+"""
+Introduce some basic refactoring functions to |jedi|. This module is still in a
+very early development stage and needs much testing and improvement.
+
+It uses the |jedi| `API <plugin-api.html>`_ and supports currently the
+following functions (sometimes bug-prone):
+
+- rename
+- extract variable
+- inline variable
+
+**I won't do too much here, but if anyone wants to step in, please do.**
+"""

 from __future__ import with_statement