--- a/eric6/Documentation/Source/eric6.Utilities.__init__.html Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Utilities.__init__.html Mon Feb 01 10:38:16 2021 +0100
@@ -23,7 +23,7 @@
<h1>eric6.Utilities.__init__</h1>
<p>
-Package implementing various functions/classes needed everywhere within eric6.
+Package implementing various functions/classes needed everywhere within eric.
</p>
<h3>Global Attributes</h3>
@@ -61,7 +61,7 @@
</tr>
<tr>
<td><a href="#checkPyside">checkPyside</a></td>
-<td>Module function to check the presence of PySide2.</td>
+<td>Module function to check the presence of PySide2/PySide6.</td>
</tr>
<tr>
<td><a href="#compactPath">compactPath</a></td>
@@ -141,7 +141,7 @@
</tr>
<tr>
<td><a href="#generatePySideToolPath">generatePySideToolPath</a></td>
-<td>Module function to generate the executable path for a PySide2 tool.</td>
+<td>Module function to generate the executable path for a PySide2/PySide6 tool.</td>
</tr>
<tr>
<td><a href="#generateQtToolName">generateQtToolName</a></td>
@@ -426,7 +426,7 @@
Special method returning a representation of the exception.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string representing the error message
</dd>
@@ -439,7 +439,7 @@
Special method returning a string representation of the exception.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string representing the error message
</dd>
@@ -506,7 +506,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
replacement string
</dd>
@@ -534,7 +534,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute path (string)
</dd>
@@ -562,7 +562,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute path with native separators (string)
</dd>
@@ -572,22 +572,22 @@
<hr />
<a NAME="checkPyside" ID="checkPyside"></a>
<h2>checkPyside</h2>
-<b>checkPyside</b>(<i>variant="2"</i>)
+<b>checkPyside</b>(<i>variant=2</i>)
<p>
- Module function to check the presence of PySide2.
+ Module function to check the presence of PySide2/PySide6.
</p>
<dl>
-<dt><i>variant</i> (str)</dt>
+<dt><i>variant</i> (int or str)</dt>
<dd>
-indicator for the PySide variant (not used)
+indicator for the PySide variant
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
-flags indicating the presence of PySide2
+flags indicating the presence of PySide2/PySide6
</dd>
</dl>
<dl>
@@ -623,7 +623,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
compacted path (string)
</dd>
@@ -650,7 +650,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
text with converted eols (string)
</dd>
@@ -673,7 +673,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of decoded text and encoding (string, string)
</dd>
@@ -696,7 +696,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
decoded text (string)
</dd>
@@ -719,7 +719,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
decoded text (string)
</dd>
@@ -744,14 +744,14 @@
<dd>
of the file (str)
</dd>
-<dt><i>editor=</i></dt>
+<dt><i>editor</i></dt>
<dd>
reference to the editor, if the file is opened
already (Editor object)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
Python version if file is Python3 (int)
</dd>
@@ -791,7 +791,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of all files and directories in the tree rooted
at path. The names are expanded to start with path.
@@ -824,7 +824,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of encoded text and encoding used
</dd>
@@ -864,7 +864,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the converted text (string)
</dd>
@@ -887,7 +887,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the converted text (string)
</dd>
@@ -919,7 +919,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dictionary of string, boolean, complex, float and int
</dd>
@@ -942,7 +942,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dictionary of string, boolean, complex, float and int
</dd>
@@ -964,21 +964,21 @@
<dd>
line to extract flags from (string)
</dd>
-<dt><i>startComment=</i></dt>
+<dt><i>startComment</i></dt>
<dd>
string identifying the start of the comment (string)
</dd>
-<dt><i>endComment=</i></dt>
+<dt><i>endComment</i></dt>
<dd>
string identifying the end of a comment (string)
</dd>
-<dt><i>flagsLine=</i></dt>
+<dt><i>flagsLine</i></dt>
<dd>
flag indicating to check for a flags only line (bool)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list containing the extracted flags (list of strings)
</dd>
@@ -1001,7 +1001,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
text without ANSI escape sequences
</dd>
@@ -1030,7 +1030,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
directory path of the given volume name
</dd>
@@ -1059,7 +1059,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path with converted separator characters (string)
</dd>
@@ -1082,7 +1082,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string with distribution infos
</dd>
@@ -1111,7 +1111,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string with plugins version infos
</dd>
@@ -1144,7 +1144,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
executable path name of the tool
</dd>
@@ -1160,10 +1160,10 @@
<hr />
<a NAME="generatePySideToolPath" ID="generatePySideToolPath"></a>
<h2>generatePySideToolPath</h2>
-<b>generatePySideToolPath</b>(<i>toolname, variant="2"</i>)
+<b>generatePySideToolPath</b>(<i>toolname, variant=2</i>)
<p>
- Module function to generate the executable path for a PySide2 tool.
+ Module function to generate the executable path for a PySide2/PySide6 tool.
</p>
<dl>
@@ -1171,15 +1171,15 @@
<dd>
base name of the tool
</dd>
-<dt><i>variant</i> (str)</dt>
+<dt><i>variant</i> (int or str)</dt>
<dd>
-indicator for the PySide variant (not used)
+indicator for the PySide variant
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
-the PySide2 tool path with extension
+the PySide2/PySide6 tool path with extension
</dd>
</dl>
<dl>
@@ -1207,7 +1207,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the Qt tool name without extension (string)
</dd>
@@ -1230,7 +1230,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string with version infos
</dd>
@@ -1263,7 +1263,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of all directories found
</dd>
@@ -1291,7 +1291,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the requested entry or the default value, if the entry wasn't
found (string or None)
@@ -1315,7 +1315,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
full executable name, if the executable file is accessible
via the searchpath defined by the PATH environment variable, or an
@@ -1340,7 +1340,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of full executable names (list of strings), if the executable
file is accessible via the searchpath defined by the PATH environment
@@ -1358,7 +1358,7 @@
Function to get a users home directory.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
home directory (string)
</dd>
@@ -1381,7 +1381,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
replacement string (string)
</dd>
@@ -1397,7 +1397,7 @@
Function to get the help text for the supported %-codes.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
help text (string)
</dd>
@@ -1413,7 +1413,7 @@
Function to determine the path to Python's library.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path to the Python library (string)
</dd>
@@ -1429,7 +1429,7 @@
Function to get the Python version (major, minor) as an integer value.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
An integer representing major and minor version number (integer)
</dd>
@@ -1452,7 +1452,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
bundle name of the Qt tool (string)
</dd>
@@ -1468,7 +1468,7 @@
Function to get the real name of the user.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
real name of the user (string)
</dd>
@@ -1492,7 +1492,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list containing sys.path of the interpreter; an empty list
is returned, if the interpreter is the one used to run eric itself
@@ -1526,7 +1526,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
filename of the corresponding unittest file (string)
</dd>
@@ -1542,7 +1542,7 @@
Function to get the user name.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
user name (string)
</dd>
@@ -1589,7 +1589,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
full executable name, if the executable file is accessible
via the searchpath defined by the PATH environment variable, or an
@@ -1614,7 +1614,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
coding string
</dd>
@@ -1637,7 +1637,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
coding string
</dd>
@@ -1660,7 +1660,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the presence of the requested entry
</dd>
@@ -1693,7 +1693,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the encoded text (string)
</dd>
@@ -1720,7 +1720,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the decoded text (string)
</dd>
@@ -1747,7 +1747,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the encoded text (string)
</dd>
@@ -1770,7 +1770,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a Windows drive
</dd>
@@ -1799,7 +1799,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating executable status (boolean)
</dd>
@@ -1822,7 +1822,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag to indicate, if the executable file is accessible
via the searchpath defined by the PATH environment variable.
@@ -1854,7 +1854,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the complete filename (string)
</dd>
@@ -1870,7 +1870,7 @@
Function to return the line separator used by the editor.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
line separator used by the editor (string)
</dd>
@@ -1898,7 +1898,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute, normalized path (string)
</dd>
@@ -1922,7 +1922,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute, normalized path (string)
</dd>
@@ -1946,7 +1946,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
case normalized path (string)
</dd>
@@ -1973,7 +1973,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
normalized path (string)
</dd>
@@ -1997,7 +1997,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of environment settings (list of strings)
</dd>
@@ -2020,7 +2020,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of options (list of strings)
</dd>
@@ -2047,7 +2047,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of parsed data
</dd>
@@ -2080,7 +2080,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
command-name and args for QProcess
</dd>
@@ -2109,7 +2109,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of decoded text and encoding (string, string)
</dd>
@@ -2130,13 +2130,13 @@
<dd>
name of the file to read (string)
</dd>
-<dt><i>encoding=</i></dt>
+<dt><i>encoding</i></dt>
<dd>
encoding to be used to read the file (string)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of decoded text and encoding (string, string)
</dd>
@@ -2160,7 +2160,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of decoded text, encoding and hash value (string, string,
string)
@@ -2184,7 +2184,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string read from the stream (string)
</dd>
@@ -2212,7 +2212,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
relative path or unchanged path, if path does not start with
the start path with universal separators (string)
@@ -2241,7 +2241,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
start position of the match or -1 indicating no match was found
</dd>
@@ -2274,7 +2274,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating whether the two paths represent the
same path on disk.
@@ -2302,7 +2302,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating whether the two paths represent the
same path on disk.
@@ -2326,7 +2326,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
a tuple of 2 strings (dirname, filename).
</dd>
@@ -2353,7 +2353,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the path starts with the given start
path (boolean)
@@ -2377,7 +2377,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
converted boolean value (boolean)
</dd>
@@ -2400,7 +2400,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path with converted separator characters (string)
</dd>
@@ -2423,7 +2423,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the converted text (string)
</dd>
@@ -2439,7 +2439,7 @@
Function to get the user name under Win32.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
user name (string)
</dd>
@@ -2462,7 +2462,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
result of the kill (boolean)
</dd>
@@ -2478,7 +2478,7 @@
Function to get the user's real name (aka. display name) under Win32.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
real name of the current user (string)
</dd>
@@ -2514,7 +2514,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
encoding used for writing the file
</dd>
