src/eric7/Documentation/Source/index-eric7.CodeFormatting.html

Fri, 27 Oct 2023 14:09:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 27 Oct 2023 14:09:40 +0200
branch
eric7
changeset 10259
b51dfacef37f
parent 9454
f3cf935c0c66
child 10479
856476537696
permissions
-rw-r--r--

Regenerated the source documentation with the corrected module parser.

9215
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.CodeFormatting</title>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <h1>eric7.CodeFormatting</h1>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 <p>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 Package implementing dialogs to perform some code formatting.
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 </p>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 <p>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 The supported code formatting systems are these.
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <ul>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <li><a href="https://github.com/psf/black">Black</a></li>
9454
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
17 <li><a href="https://pycqa.github.io/isort/">isort</a></li>
9215
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 </ul
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </p>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h3>Modules</h3>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <table>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <td><a href="eric7.CodeFormatting.BlackConfigurationDialog.html">BlackConfigurationDialog</a></td>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <td>Module implementing a dialog to enter the parameters for a Black formatting run.</td>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 </tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <td><a href="eric7.CodeFormatting.BlackFormattingAction.html">BlackFormattingAction</a></td>
9454
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
31 <td>Module implementing an enum defining the various Black code formatting actions.</td>
9215
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="eric7.CodeFormatting.BlackFormattingDialog.html">BlackFormattingDialog</a></td>
9454
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
35 <td>Module implementing a dialog showing the Black code formatting progress and the results.</td>
9215
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="eric7.CodeFormatting.BlackUtilities.html">BlackUtilities</a></td>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Module implementing some utility functions for the Black based code formatting.</td>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
9454
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
41 <tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
42 <td><a href="eric7.CodeFormatting.FormattingDiffWidget.html">FormattingDiffWidget</a></td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
43 <td>Module implementing a window to show a unified diff..</td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
44 </tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
45 <tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
46 <td><a href="eric7.CodeFormatting.IsortConfigurationDialog.html">IsortConfigurationDialog</a></td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
47 <td>Module implementing a dialog to enter the parameters for an isort formatting run.</td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
48 </tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
49 <tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
50 <td><a href="eric7.CodeFormatting.IsortFormattingAction.html">IsortFormattingAction</a></td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
51 <td>Module implementing an enum defining the various isort code formatting actions.</td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
52 </tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
53 <tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
54 <td><a href="eric7.CodeFormatting.IsortFormattingDialog.html">IsortFormattingDialog</a></td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
55 <td>Module implementing a dialog showing the isort code formatting progress and the results.</td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
56 </tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
57 <tr>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
58 <td><a href="eric7.CodeFormatting.IsortUtilities.html">IsortUtilities</a></td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
59 <td>Module implementing some utility functions for the isort import statement formatting tool.</td>
f3cf935c0c66 Regenerated the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9215
diff changeset
60 </tr>
9215
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </table>
30d7f7fd2b4a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </body></html>

eric ide

mercurial