Mon, 31 Oct 2022 16:32:14 +0100
Regenerated the source documentation.
--- a/src/eric7/APIs/Python3/eric7.api Mon Oct 31 16:31:29 2022 +0100 +++ b/src/eric7/APIs/Python3/eric7.api Mon Oct 31 16:32:14 2022 +0100 @@ -44,10 +44,10 @@ eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.FileNameColumn?7 eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.StatusColumn?7 eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.closeEvent?4(evt) -eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.formattingWorkerTask?4(outputQueue, isortConfig) eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.on_buttonBox_clicked?4(button) eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.on_resultsList_itemDoubleClicked?4(item, column) eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged?4(status) +eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog.sortingWorkerTask?4(outputQueue, isortConfig) eric7.CodeFormatting.IsortFormattingDialog.IsortFormattingDialog?1(configuration, filesList, project=None, action=IsortFormattingAction.Sort, parent=None, ) eric7.CodeFormatting.IsortUtilities.aboutIsort?4() eric7.CodeFormatting.IsortUtilities.suppressStderr?4()
--- a/src/eric7/Documentation/Help/source.qhp Mon Oct 31 16:31:29 2022 +0100 +++ b/src/eric7/Documentation/Help/source.qhp Mon Oct 31 16:32:14 2022 +0100 @@ -9692,8 +9692,6 @@ <keyword name="IsortFormattingDialog (Module)" id="IsortFormattingDialog (Module)" ref="eric7.CodeFormatting.IsortFormattingDialog.html" /> <keyword name="IsortFormattingDialog.__filterFiles" id="IsortFormattingDialog.__filterFiles" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__filterFiles" /> <keyword name="IsortFormattingDialog.__finish" id="IsortFormattingDialog.__finish" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__finish" /> - <keyword name="IsortFormattingDialog.__formatManyFiles" id="IsortFormattingDialog.__formatManyFiles" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__formatManyFiles" /> - <keyword name="IsortFormattingDialog.__formatOneFile" id="IsortFormattingDialog.__formatOneFile" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__formatOneFile" /> <keyword name="IsortFormattingDialog.__handleIsortResult" id="IsortFormattingDialog.__handleIsortResult" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__handleIsortResult" /> <keyword name="IsortFormattingDialog.__isortCheckFile" id="IsortFormattingDialog.__isortCheckFile" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__isortCheckFile" /> <keyword name="IsortFormattingDialog.__isortSortFile" id="IsortFormattingDialog.__isortSortFile" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__isortSortFile" /> @@ -9702,12 +9700,14 @@ <keyword name="IsortFormattingDialog.__resizeColumns" id="IsortFormattingDialog.__resizeColumns" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__resizeColumns" /> <keyword name="IsortFormattingDialog.__resort" id="IsortFormattingDialog.__resort" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__resort" /> <keyword name="IsortFormattingDialog.__sortImportsButtonClicked" id="IsortFormattingDialog.__sortImportsButtonClicked" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__sortImportsButtonClicked" /> + <keyword name="IsortFormattingDialog.__sortManyFiles" id="IsortFormattingDialog.__sortManyFiles" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__sortManyFiles" /> + <keyword name="IsortFormattingDialog.__sortOneFile" id="IsortFormattingDialog.__sortOneFile" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__sortOneFile" /> <keyword name="IsortFormattingDialog.__updateStatistics" id="IsortFormattingDialog.__updateStatistics" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.__updateStatistics" /> <keyword name="IsortFormattingDialog.closeEvent" id="IsortFormattingDialog.closeEvent" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.closeEvent" /> - <keyword name="IsortFormattingDialog.formattingWorkerTask" id="IsortFormattingDialog.formattingWorkerTask" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.formattingWorkerTask" /> <keyword name="IsortFormattingDialog.on_buttonBox_clicked" id="IsortFormattingDialog.on_buttonBox_clicked" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.on_buttonBox_clicked" /> <keyword name="IsortFormattingDialog.on_resultsList_itemDoubleClicked" id="IsortFormattingDialog.on_resultsList_itemDoubleClicked" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.on_resultsList_itemDoubleClicked" /> <keyword name="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged" id="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged" /> + <keyword name="IsortFormattingDialog.sortingWorkerTask" id="IsortFormattingDialog.sortingWorkerTask" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortFormattingDialog.sortingWorkerTask" /> <keyword name="IsortResult" id="IsortResult" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortResult" /> <keyword name="IsortStatistics" id="IsortStatistics" ref="eric7.CodeFormatting.IsortFormattingDialog.html#IsortStatistics" /> <keyword name="IsortUtilities (Module)" id="IsortUtilities (Module)" ref="eric7.CodeFormatting.IsortUtilities.html" />
--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.IsortFormattingDialog.html Mon Oct 31 16:31:29 2022 +0100 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.IsortFormattingDialog.html Mon Oct 31 16:32:14 2022 +0100 @@ -26,11 +26,11 @@ </tr> <tr> <td><a href="#IsortResult">IsortResult</a></td> -<td>Class containing the isort reformatting result data.</td> +<td>Class containing the isort result data.</td> </tr> <tr> <td><a href="#IsortStatistics">IsortStatistics</a></td> -<td>Class containing the isort reformatting statistic data.</td> +<td>Class containing the isort statistic data.</td> </tr> </table> <h3>Functions</h3> @@ -76,20 +76,12 @@ <td>Private method to perform some actions after the run was performed or canceled.</td> </tr> <tr> -<td><a href="#IsortFormattingDialog.__formatManyFiles">__formatManyFiles</a></td> -<td>Private method to format the list of files according the configuration using multiple processes in parallel.</td> -</tr> -<tr> -<td><a href="#IsortFormattingDialog.__formatOneFile">__formatOneFile</a></td> -<td>Private method to format the list of files according the configuration.</td> -</tr> -<tr> <td><a href="#IsortFormattingDialog.__handleIsortResult">__handleIsortResult</a></td> -<td>Private method to handle an isort formatting result.</td> +<td>Private method to handle an isort sorting result.</td> </tr> <tr> <td><a href="#IsortFormattingDialog.__performAction">__performAction</a></td> -<td>Private method to execute the requested formatting action.</td> +<td>Private method to execute the requested sorting action.</td> </tr> <tr> <td><a href="#IsortFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td> @@ -108,8 +100,16 @@ <td>Private slot handling the selection of the 'Sort Imports' button.</td> </tr> <tr> +<td><a href="#IsortFormattingDialog.__sortManyFiles">__sortManyFiles</a></td> +<td>Private method to sort imports of the list of files according the configuration using multiple processes in parallel.</td> +</tr> +<tr> +<td><a href="#IsortFormattingDialog.__sortOneFile">__sortOneFile</a></td> +<td>Private method to sort the imports of the list of files according the configuration.</td> +</tr> +<tr> <td><a href="#IsortFormattingDialog.__updateStatistics">__updateStatistics</a></td> -<td>Private method to update the statistics about the recent formatting run and make them visible.</td> +<td>Private method to update the statistics about the recent sorting run and make them visible.</td> </tr> <tr> <td><a href="#IsortFormattingDialog.closeEvent">closeEvent</a></td> @@ -141,7 +141,7 @@ <td>Static method to sort the import statements of a file.</td> </tr> <tr> -<td><a href="#IsortFormattingDialog.formattingWorkerTask">formattingWorkerTask</a></td> +<td><a href="#IsortFormattingDialog.sortingWorkerTask">sortingWorkerTask</a></td> <td>Static method acting as the parallel worker for the formatting task.</td> </tr> </table> @@ -210,41 +210,12 @@ <p> Private method to perform some actions after the run was performed or canceled. </p> -<a NAME="IsortFormattingDialog.__formatManyFiles" ID="IsortFormattingDialog.__formatManyFiles"></a> -<h4>IsortFormattingDialog.__formatManyFiles</h4> -<b>__formatManyFiles</b>(<i>files</i>) - -<p> - Private method to format the list of files according the configuration using - multiple processes in parallel. -</p> -<dl> - -<dt><i>files</i> (list of str)</dt> -<dd> -list of files to be processed -</dd> -</dl> -<a NAME="IsortFormattingDialog.__formatOneFile" ID="IsortFormattingDialog.__formatOneFile"></a> -<h4>IsortFormattingDialog.__formatOneFile</h4> -<b>__formatOneFile</b>(<i>file</i>) - -<p> - Private method to format the list of files according the configuration. -</p> -<dl> - -<dt><i>file</i> (str)</dt> -<dd> -name of the file to be processed -</dd> -</dl> <a NAME="IsortFormattingDialog.__handleIsortResult" ID="IsortFormattingDialog.__handleIsortResult"></a> <h4>IsortFormattingDialog.__handleIsortResult</h4> <b>__handleIsortResult</b>(<i>filename, status, data=""</i>) <p> - Private method to handle an isort formatting result. + Private method to handle an isort sorting result. </p> <dl> @@ -267,7 +238,7 @@ <b>__performAction</b>(<i></i>) <p> - Private method to execute the requested formatting action. + Private method to execute the requested sorting action. </p> <a NAME="IsortFormattingDialog.__populateStatusFilterCombo" ID="IsortFormattingDialog.__populateStatusFilterCombo"></a> <h4>IsortFormattingDialog.__populateStatusFilterCombo</h4> @@ -297,12 +268,42 @@ <p> Private slot handling the selection of the 'Sort Imports' button. </p> +<a NAME="IsortFormattingDialog.__sortManyFiles" ID="IsortFormattingDialog.__sortManyFiles"></a> +<h4>IsortFormattingDialog.__sortManyFiles</h4> +<b>__sortManyFiles</b>(<i>files</i>) + +<p> + Private method to sort imports of the list of files according the configuration + using multiple processes in parallel. +</p> +<dl> + +<dt><i>files</i> (list of str)</dt> +<dd> +list of files to be processed +</dd> +</dl> +<a NAME="IsortFormattingDialog.__sortOneFile" ID="IsortFormattingDialog.__sortOneFile"></a> +<h4>IsortFormattingDialog.__sortOneFile</h4> +<b>__sortOneFile</b>(<i>file</i>) + +<p> + Private method to sort the imports of the list of files according the + configuration. +</p> +<dl> + +<dt><i>file</i> (str)</dt> +<dd> +name of the file to be processed +</dd> +</dl> <a NAME="IsortFormattingDialog.__updateStatistics" ID="IsortFormattingDialog.__updateStatistics"></a> <h4>IsortFormattingDialog.__updateStatistics</h4> <b>__updateStatistics</b>(<i></i>) <p> - Private method to update the statistics about the recent formatting run and + Private method to update the statistics about the recent sorting run and make them visible. </p> <a NAME="IsortFormattingDialog.closeEvent" ID="IsortFormattingDialog.closeEvent"></a> @@ -430,9 +431,9 @@ IsortResult </dd> </dl> -<a NAME="IsortFormattingDialog.formattingWorkerTask" ID="IsortFormattingDialog.formattingWorkerTask"></a> -<h4>IsortFormattingDialog.formattingWorkerTask (static)</h4> -<b>formattingWorkerTask</b>(<i>outputQueue, isortConfig</i>) +<a NAME="IsortFormattingDialog.sortingWorkerTask" ID="IsortFormattingDialog.sortingWorkerTask"></a> +<h4>IsortFormattingDialog.sortingWorkerTask (static)</h4> +<b>sortingWorkerTask</b>(<i>outputQueue, isortConfig</i>) <p> Static method acting as the parallel worker for the formatting task. @@ -459,7 +460,7 @@ <h2>IsortResult</h2> <p> - Class containing the isort reformatting result data. + Class containing the isort result data. </p> <h3>Derived from</h3> None @@ -491,7 +492,7 @@ <h2>IsortStatistics</h2> <p> - Class containing the isort reformatting statistic data. + Class containing the isort statistic data. </p> <h3>Derived from</h3> None