--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Sun Oct 08 19:11:45 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Sat Oct 14 19:31:11 2017 +0200 @@ -75,9 +75,15 @@ <td><a href="#CodeAssistClient.__getConfig">__getConfig</a></td> <td>Private method to send some configuration data to the server.</td> </tr><tr> +<td><a href="#CodeAssistClient.__getDocumentation">__getDocumentation</a></td> +<td>Private method to get some source code documentation.</td> +</tr><tr> <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td> <td>Private method to process a rope error.</td> </tr><tr> +<td><a href="#CodeAssistClient.__processDocumentation">__processDocumentation</a></td> +<td>Private method to process the call-tips and documentation.</td> +</tr><tr> <td><a href="#CodeAssistClient.__reportChanged">__reportChanged</a></td> <td>Private method to register some changed sources.</td> </tr><tr> @@ -162,6 +168,16 @@ dictionary containing the method parameters sent by the server </dd> +</dl><a NAME="CodeAssistClient.__getDocumentation" ID="CodeAssistClient.__getDocumentation"></a> +<h4>CodeAssistClient.__getDocumentation</h4> +<b>__getDocumentation</b>(<i>params</i>) +<p> + Private method to get some source code documentation. +</p><dl> +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the method parameters +</dd> </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> <h4>CodeAssistClient.__handleRopeError</h4> <b>__handleRopeError</b>(<i>err</i>) @@ -182,6 +198,30 @@ <dd> dict </dd> +</dl><a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a> +<h4>CodeAssistClient.__processDocumentation</h4> +<b>__processDocumentation</b>(<i>cts, documentation</i>) +<p> + Private method to process the call-tips and documentation. +</p><dl> +<dt><i>cts</i> (str)</dt> +<dd> +call-tips +</dd><dt><i>documentation</i> (str)</dt> +<dd> +extracted source code documentation +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +dictionary containing document information +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +dictionary with keys "name", "argspec", "module" and + "docstring" +</dd> </dl><a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a> <h4>CodeAssistClient.__reportChanged</h4> <b>__reportChanged</b>(<i>params</i>)