--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackConfigurationDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackConfigurationDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CodeFormatting.BlackConfigurationDialog</h1>
-
<p>
Module implementing a dialog to enter the parameters for a Black formatting run.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#BlackConfigurationDialog">BlackConfigurationDialog</a></td>
<td>Class implementing a dialog to enter the parameters for a Black formatting run.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="BlackConfigurationDialog" ID="BlackConfigurationDialog"></a>
<h2>BlackConfigurationDialog</h2>
-
<p>
Class implementing a dialog to enter the parameters for a Black formatting run.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_BlackConfigurationDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BlackConfigurationDialog.__init__">BlackConfigurationDialog</a></td>
<td>Constructor</td>
@@ -91,19 +88,20 @@
<td>Private slot to validate the entered exclusion regular expression.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BlackConfigurationDialog.__init__" ID="BlackConfigurationDialog.__init__"></a>
<h4>BlackConfigurationDialog (Constructor)</h4>
<b>BlackConfigurationDialog</b>(<i>withProject=True, onlyProject=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>withProject</i> (bool (optional))</dt>
@@ -124,7 +122,6 @@
<a NAME="BlackConfigurationDialog.__createTomlSnippet" ID="BlackConfigurationDialog.__createTomlSnippet"></a>
<h4>BlackConfigurationDialog.__createTomlSnippet</h4>
<b>__createTomlSnippet</b>(<i></i>)
-
<p>
Private slot to generate a TOML snippet of the current configuration.
</p>
@@ -135,13 +132,14 @@
The code snippet is copied to the clipboard and may be placed inside the
'pyproject.toml' file.
</p>
+
<a NAME="BlackConfigurationDialog.__getTargetList" ID="BlackConfigurationDialog.__getTargetList"></a>
<h4>BlackConfigurationDialog.__getTargetList</h4>
<b>__getTargetList</b>(<i></i>)
-
<p>
Private method to get the list of checked target versions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -157,11 +155,11 @@
<a NAME="BlackConfigurationDialog.__loadConfiguration" ID="BlackConfigurationDialog.__loadConfiguration"></a>
<h4>BlackConfigurationDialog.__loadConfiguration</h4>
<b>__loadConfiguration</b>(<i>configurationDict</i>)
-
<p>
Private method to load the configuration section with data of the given
dictionary.
</p>
+
<dl>
<dt><i>configurationDict</i> (dict)</dt>
@@ -172,18 +170,18 @@
<a NAME="BlackConfigurationDialog.__populateTargetVersionsList" ID="BlackConfigurationDialog.__populateTargetVersionsList"></a>
<h4>BlackConfigurationDialog.__populateTargetVersionsList</h4>
<b>__populateTargetVersionsList</b>(<i></i>)
-
<p>
Private method to populate the target versions list widget with checkable
Python version entries.
</p>
+
<a NAME="BlackConfigurationDialog.getConfiguration" ID="BlackConfigurationDialog.getConfiguration"></a>
<h4>BlackConfigurationDialog.getConfiguration</h4>
<b>getConfiguration</b>(<i>saveToProject=False</i>)
-
<p>
Public method to get the current configuration parameters.
</p>
+
<dl>
<dt><i>saveToProject</i> (bool (optional))</dt>
@@ -207,17 +205,17 @@
<a NAME="BlackConfigurationDialog.on_excludeEdit_textChanged" ID="BlackConfigurationDialog.on_excludeEdit_textChanged"></a>
<h4>BlackConfigurationDialog.on_excludeEdit_textChanged</h4>
<b>on_excludeEdit_textChanged</b>(<i></i>)
-
<p>
Private slot to enable the validate button depending on the exclude text.
</p>
+
<a NAME="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged" ID="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged"></a>
<h4>BlackConfigurationDialog.on_sourceComboBox_currentTextChanged</h4>
<b>on_sourceComboBox_currentTextChanged</b>(<i>selection</i>)
-
<p>
Private slot to handle the selection of a configuration source.
</p>
+
<dl>
<dt><i>selection</i> (str)</dt>
@@ -228,10 +226,10 @@
<a NAME="BlackConfigurationDialog.on_validateButton_clicked" ID="BlackConfigurationDialog.on_validateButton_clicked"></a>
<h4>BlackConfigurationDialog.on_validateButton_clicked</h4>
<b>on_validateButton_clicked</b>(<i></i>)
-
<p>
Private slot to validate the entered exclusion regular expression.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
