diff -r bd28e56047d7 -r 30d7f7fd2b4a src/eric7/Documentation/Source/eric7.Project.Project.html --- a/src/eric7/Documentation/Source/eric7.Project.Project.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.Project.html Mon Jul 11 16:47:57 2022 +0200 @@ -257,6 +257,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#Project.__aboutBlack">__aboutBlack</a></td> +<td>Private slot to show some information about the installed 'Black' tool.</td> +</tr> +<tr> <td><a href="#Project.__addRecursiveDirectory">__addRecursiveDirectory</a></td> <td>Private method used to add all files of a directory tree.</td> </tr> @@ -353,6 +357,10 @@ <td>Private method to open a project from the list of rencently opened projects.</td> </tr> <tr> +<td><a href="#Project.__performFormatWithBlack">__performFormatWithBlack</a></td> +<td>Private method to format the project sources using the 'Black' tool.</td> +</tr> +<tr> <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td> <td>Private slot to create eric plugin archives.</td> </tr> @@ -429,6 +437,10 @@ <td>Private slot called before the Debugger menu is shown.</td> </tr> <tr> +<td><a href="#Project.__showContextMenuFormat">__showContextMenuFormat</a></td> +<td>Private slot called before the 'Code Formatting' menu is shown.</td> +</tr> +<tr> <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td> <td>Private slot called before the graphics menu is shown.</td> </tr> @@ -1121,6 +1133,13 @@ optional filename of a project file to open (string) </dd> </dl> +<a NAME="Project.__aboutBlack" ID="Project.__aboutBlack"></a> +<h4>Project.__aboutBlack</h4> +<b>__aboutBlack</b>(<i></i>) + +<p> + Private slot to show some information about the installed 'Black' tool. +</p> <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> <h4>Project.__addRecursiveDirectory</h4> <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) @@ -1481,6 +1500,30 @@ reference to the action that triggered (QAction) </dd> </dl> +<a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a> +<h4>Project.__performFormatWithBlack</h4> +<b>__performFormatWithBlack</b>(<i>action</i>) + +<p> + Private method to format the project sources using the 'Black' tool. +</p> +<p> + Following actions are supported. + <ul> + <li>BlackFormattingAction.Format - the code reformatting is performed</li> + <li>BlackFormattingAction.Check - a check is performed, if code formatting + is necessary</li> + <li>BlackFormattingAction.Diff - a unified diff of potential code formatting + changes is generated</li> + </ul> +</p> +<dl> + +<dt><i>action</i> (BlackFormattingAction)</dt> +<dd> +formatting operation to be performed +</dd> +</dl> <a NAME="Project.__pluginCreateArchives" ID="Project.__pluginCreateArchives"></a> <h4>Project.__pluginCreateArchives</h4> <b>__pluginCreateArchives</b>(<i>snapshot=False</i>) @@ -1690,6 +1733,13 @@ <p> Private slot called before the Debugger menu is shown. </p> +<a NAME="Project.__showContextMenuFormat" ID="Project.__showContextMenuFormat"></a> +<h4>Project.__showContextMenuFormat</h4> +<b>__showContextMenuFormat</b>(<i></i>) + +<p> + Private slot called before the 'Code Formatting' menu is shown. +</p> <a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a> <h4>Project.__showContextMenuGraphics</h4> <b>__showContextMenuGraphics</b>(<i></i>)