Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.Utilities.__init__.html	Sat Feb 03 16:15:24 2018 +0100
+++ b/Documentation/Source/eric6.Utilities.__init__.html	Sat Feb 03 16:46:32 2018 +0100
@@ -188,7 +188,7 @@
 <td>Function to join a file extension to a path.</td>
 </tr><tr>
 <td><a href="#linesep">linesep</a></td>
-<td>Function to return the lineseparator used by the editor.</td>
+<td>Function to return the line separator used by the editor.</td>
 </tr><tr>
 <td><a href="#normabsjoinpath">normabsjoinpath</a></td>
 <td>Function returning a normalized, absolute path of the joined parts passed into it.</td>
@@ -610,21 +610,30 @@
 <hr /><hr />
 <a NAME="encode" ID="encode"></a>
 <h2>encode</h2>
-<b>encode</b>(<i>text, orig_coding</i>)
+<b>encode</b>(<i>text, origEncoding, forcedEncoding=""</i>)
 <p>
     Function to encode text into a byte text.
 </p><dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
+<dd>
+text to be encoded
+</dd><dt><i>origEncoding</i> (str)</dt>
 <dd>
-text to be encoded (string)
-</dd><dt><i>orig_coding</i></dt>
+type of the original encoding
+</dd><dt><i>forcedEncoding</i> (str)</dt>
 <dd>
-type of the original encoding (string)
+encoding to be used for writing, if no coding line
+        is present
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-tuple of encoded text and encoding used (bytes, string)
+tuple of encoded text and encoding used
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bytes, str)
 </dd>
 </dl><dl>
 <dt>Raises <b>CodingError</b>:</dt>
@@ -1352,7 +1361,7 @@
 <h2>linesep</h2>
 <b>linesep</b>(<i></i>)
 <p>
-    Function to return the lineseparator used by the editor.
+    Function to return the line separator used by the editor.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -1892,24 +1901,33 @@
 <hr /><hr />
 <a NAME="writeEncodedFile" ID="writeEncodedFile"></a>
 <h2>writeEncodedFile</h2>
-<b>writeEncodedFile</b>(<i>filename, text, orig_coding</i>)
+<b>writeEncodedFile</b>(<i>filename, text, origEncoding, forcedEncoding=""</i>)
 <p>
     Function to write a file with properly encoded text.
 </p><dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the file to read (string)
-</dd><dt><i>text</i></dt>
+name of the file to read
+</dd><dt><i>text</i> (str)</dt>
 <dd>
-text to be written (string)
-</dd><dt><i>orig_coding</i></dt>
+text to be written
+</dd><dt><i>origEncoding</i> (str)</dt>
 <dd>
-type of the original encoding (string)
+type of the original encoding
+</dd><dt><i>forcedEncoding</i> (str)</dt>
+<dd>
+encoding to be used for writing, if no coding
+        line is present
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-encoding used for writing the file (string)
+encoding used for writing the file
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>