Mercurial Repositories > Rope Refactoring / file diff

--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html	Sun Oct 13 18:35:25 2013 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html	Fri Oct 25 19:33:36 2013 +0200
@@ -160,7 +160,7 @@
 <td>Private slot to perform SOA on all modules.</td>
 </tr><tr>
 <td><a href="#Refactoring.__queryDefinition">__queryDefinition</a></td>
-<td>Private slot to handle the Find Definition action</td>
+<td>Private slot to handle the Find Definition action.</td>
 </tr><tr>
 <td><a href="#Refactoring.__queryImplementations">__queryImplementations</a></td>
 <td>Private slot to handle the Find Implementations action.</td>
@@ -372,12 +372,25 @@
 kind of extraction to be done (string,
             "method" or "variable")
 </dd>
+</dl><dl>
+<dt>Raises <b>Exception</b>:</dt>
+<dd>
+raised to indicate a wrong extraction method
+</dd>
 </dl><a NAME="Refactoring.__doImports" ID="Refactoring.__doImports"></a>
 <h4>Refactoring.__doImports</h4>
 <b>__doImports</b>(<i>title, method</i>)
 <p>
         Private method to perform the various imports refactorings.
-</p><a NAME="Refactoring.__doRename" ID="Refactoring.__doRename"></a>
+</p><dl>
+<dt><i>title</i></dt>
+<dd>
+title to be used for the import refactoring (string)
+</dd><dt><i>method</i></dt>
+<dd>
+method performing the import refactoring
+</dd>
+</dl><a NAME="Refactoring.__doRename" ID="Refactoring.__doRename"></a>
 <h4>Refactoring.__doRename</h4>
 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>)
 <p>
@@ -451,7 +464,8 @@
 <h4>Refactoring.__getOffset</h4>
 <b>__getOffset</b>(<i>editor, line, index</i>)
 <p>
-        Private method to get the offset into the text treating CRLF as ONE character.
+        Private method to get the offset into the text treating CRLF as ONE
+        character.
 </p><p>
         Note: rope seems to convert all EOL styles to just \n.
 </p><dl>
@@ -540,7 +554,7 @@
 <h4>Refactoring.__queryDefinition</h4>
 <b>__queryDefinition</b>(<i></i>)
 <p>
-        Private slot to handle the Find Definition action
+        Private slot to handle the Find Definition action.
 </p><a NAME="Refactoring.__queryImplementations" ID="Refactoring.__queryImplementations"></a>
 <h4>Refactoring.__queryImplementations</h4>
 <b>__queryImplementations</b>(<i></i>)
@@ -742,9 +756,10 @@
 <p>
         Public method to refresh modified editors.
 </p><dl>
-<dt><i>reference</i></dt>
+<dt><i>changes</i></dt>
 <dd>
-to the Changes object (rope.base.change.ChangeSet)
+reference to the ChangeSet object
+            (rope.base.change.ChangeSet)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>