Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.Utilities.__init__.html	Tue Oct 15 22:03:54 2013 +0200
+++ b/Documentation/Source/eric5.Utilities.__init__.html	Fri Oct 18 23:00:41 2013 +0200
@@ -113,7 +113,7 @@
 <td>Function to build all full path of an executable file from the environment.</td>
 </tr><tr>
 <td><a href="#getHomeDir">getHomeDir</a></td>
-<td>Function to get a users home directory</td>
+<td>Function to get a users home directory.</td>
 </tr><tr>
 <td><a href="#getPercentReplacement">getPercentReplacement</a></td>
 <td>Function to get the replacement for code.</td>
@@ -237,7 +237,8 @@
 <a NAME="CodingError" ID="CodingError"></a>
 <h2>CodingError</h2>
 <p>
-    Class implementing an exception, which is raised, if a given coding is incorrect.
+    Class implementing an exception, which is raised, if a given coding is
+    incorrect.
 </p>
 <h3>Derived from</h3>
 Exception
@@ -271,7 +272,12 @@
 <b>CodingError</b>(<i>coding</i>)
 <p>
         Constructor
-</p><a NAME="CodingError.__repr__" ID="CodingError.__repr__"></a>
+</p><dl>
+<dt><i>coding</i></dt>
+<dd>
+coding to include in the message (string)
+</dd>
+</dl><a NAME="CodingError.__repr__" ID="CodingError.__repr__"></a>
 <h4>CodingError.__repr__</h4>
 <b>__repr__</b>(<i></i>)
 <p>
@@ -544,6 +550,11 @@
 <dd>
 tuple of encoded text and encoding used (bytes, string)
 </dd>
+</dl><dl>
+<dt>Raises <b>CodingError</b>:</dt>
+<dd>
+raised to indicate an invalid encoding
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -826,7 +837,7 @@
 <h2>getHomeDir</h2>
 <b>getHomeDir</b>(<i></i>)
 <p>
-    Function to get a users home directory
+    Function to get a users home directory.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -1358,6 +1369,16 @@
 <dd>
 path to make relative from (string)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+relative path (string)
+</dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an invalid path
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -1498,7 +1519,12 @@
 </p><dl>
 <dt><i>pid</i></dt>
 <dd>
-process id
+process id (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+result of the kill (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>