From 12d9d5b9fd6d84e3772c6189d5f0ac830da46398 Mon Sep 17 00:00:00 2001
From: David Halter <davidhalter88@gmail.com>
Date: Tue, 5 Feb 2013 23:25:39 +0100
Subject: [PATCH] refactoring docstring

---
 jedi/refactoring.py | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/jedi/refactoring.py b/jedi/refactoring.py
index 677f1051..af7506f6 100644
--- 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