APIs: changeset 68:2311d81b8606

--- a/Documentation/source/Plugin_Apis.PluginApis.html	Sat Dec 23 15:48:43 2023 +0100
+++ b/Documentation/source/Plugin_Apis.PluginApis.html	Sat Dec 23 15:58:15 2023 +0100
@@ -2,21 +2,7 @@
 <html><head>
 <title>Plugin_Apis.PluginApis</title>
 <meta charset="UTF-8">
-<style>
-body {
-    background: #EDECE6;
-    margin: 0em 1em 10em 1em;
-    color: black;
-}
-
-h1 { color: white; background: #85774A; }
-h2 { color: white; background: #85774A; }
-h3 { color: white; background: #9D936E; }
-h4 { color: white; background: #9D936E; }
-
-a { color: #BA6D36; }
-
-</style>
+<link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <a NAME="top" ID="top"></a>
@@ -100,9 +86,9 @@
 </p>
 <dl>

-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
 </dd>
 </dl>
 <a NAME="PluginApis.activate" ID="PluginApis.activate"></a>
@@ -115,7 +101,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (None, bool)
 </dd>
 </dl>
 <a NAME="PluginApis.deactivate" ID="PluginApis.deactivate"></a>
@@ -137,15 +129,21 @@
 </p>
 <dl>

-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-language to get APIs for (string)
+language to get APIs for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of API filenames (list of string)
+list of API filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/source/index-Plugin_Apis.html	Sat Dec 23 15:48:43 2023 +0100
+++ b/Documentation/source/index-Plugin_Apis.html	Sat Dec 23 15:58:15 2023 +0100
@@ -2,21 +2,7 @@
 <html><head>
 <title>Plugin_Apis</title>
 <meta charset="UTF-8">
-<style>
-body {
-    background: #EDECE6;
-    margin: 0em 1em 10em 1em;
-    color: black;
-}
-
-h1 { color: white; background: #85774A; }
-h2 { color: white; background: #85774A; }
-h3 { color: white; background: #9D936E; }
-h4 { color: white; background: #9D936E; }
-
-a { color: #BA6D36; }
-
-</style>
+<link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <h1>Plugin_Apis</h1>
--- a/Documentation/source/index.html	Sat Dec 23 15:48:43 2023 +0100
+++ b/Documentation/source/index.html	Sat Dec 23 15:58:15 2023 +0100
@@ -2,21 +2,7 @@
 <html><head>
 <title>Table of contents</title>
 <meta charset="UTF-8">
-<style>
-body {
-    background: #EDECE6;
-    margin: 0em 1em 10em 1em;
-    color: black;
-}
-
-h1 { color: white; background: #85774A; }
-h2 { color: white; background: #85774A; }
-h3 { color: white; background: #9D936E; }
-h4 { color: white; background: #9D936E; }
-
-a { color: #BA6D36; }
-
-</style>
+<link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <h1>Table of contents</h1>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/source/styles.css	Sat Dec 23 15:58:15 2023 +0100
@@ -0,0 +1,12 @@
+body {
+    color: black;
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
--- a/PluginApis.epj	Sat Dec 23 15:48:43 2023 +0100
+++ b/PluginApis.epj	Sat Dec 23 15:58:15 2023 +0100
@@ -11,10 +11,14 @@
           "AllowStarArgAny": false,
           "AllowUntypedDefs": false,
           "AllowUntypedNested": false,
+          "CheckFutureAnnotations": false,
           "DispatchDecorators": [
             "singledispatch",
             "singledispatchmethod"
           ],
+          "ExemptedTypingSymbols": [
+            ""
+          ],
           "ForceFutureAnnotations": false,
           "MaximumComplexity": 3,
           "MaximumLength": 7,
@@ -62,9 +66,9 @@
         "CopyrightAuthor": "",
         "CopyrightMinFileSize": 0,
         "DocstringType": "eric_black",
-        "EnabledCheckerCategories": "C, D, E, M, N, S, Y, W",
+        "EnabledCheckerCategories": "C, D, E, I, L, M, NO, N, Y, U, W",
         "ExcludeFiles": "*/Ui_*.py, */*_rc.py,",
-        "ExcludeMessages": "C101,E265,E266,E305,E402,M201,M301,M302,M303,M304,M305,M306,M307,M308,M311,M312,M313,M314,M315,M321,M701,M702,M811,M834,N802,N803,N807,N808,N821,W293,W503,Y119,Y401,Y402",
+        "ExcludeMessages": "C101,E265,E266,E305,E402,M201,M301,M302,M303,M304,M305,M306,M307,M308,M311,M312,M313,M314,M315,M321,M701,M702,M811,M834,M852,N802,N803,N807,N808,N821,W293,W503,Y119,Y401,Y402",
         "FixCodes": "",
         "FixIssues": false,
         "FutureChecker": "",
@@ -80,6 +84,14 @@
         "MaxCodeComplexity": 10,
         "MaxDocLineLength": 88,
         "MaxLineLength": 88,
+        "NameOrderChecker": {
+          "ApplicationPackageNames": [],
+          "CombinedAsImports": false,
+          "SortCaseSensitive": false,
+          "SortFromFirst": false,
+          "SortIgnoringStyle": false,
+          "SortOrder": "natural"
+        },
         "NoFixCodes": "E501",
         "RepeatMessages": true,
         "SecurityChecker": {
@@ -113,6 +125,19 @@
           "WeakKeySizeRsaMedium": "2048"
         },
         "ShowIgnored": false,
+        "UnusedChecker": {
+          "IgnoreAbstract": true,
+          "IgnoreDunderGlobals": true,
+          "IgnoreDunderMethods": true,
+          "IgnoreEventHandlerMethods": false,
+          "IgnoreLambdas": false,
+          "IgnoreNestedFunctions": false,
+          "IgnoreOverload": true,
+          "IgnoreOverride": true,
+          "IgnoreSlotMethods": false,
+          "IgnoreStubs": true,
+          "IgnoreVariadicNames": false
+        },
         "ValidEncodings": "latin-1, utf-8"
       }
     },
@@ -134,6 +159,7 @@
         ],
         "outputDirectory": "Documentation/source",
         "qtHelpEnabled": false,
+        "startDirectory": "",
         "useRecursion": true
       }
     },
--- a/PluginApis.py	Sat Dec 23 15:48:43 2023 +0100
+++ b/PluginApis.py	Sat Dec 23 15:58:15 2023 +0100
@@ -36,8 +36,10 @@
     """
     Module function to return the API files made available by this plugin.

-    @param language language to get APIs for (string)
-    @return list of API filenames (list of string)
+    @param language language to get APIs for
+    @type str
+    @return list of API filenames
+    @rtype list of str
     """
     if language:
         apisDir = os.path.join(os.path.dirname(__file__), "APIs", language)
@@ -55,7 +57,8 @@
         """
         Constructor

-        @param ui reference to the user interface object (UI.UserInterface)
+        @param ui reference to the user interface object
+        @type UserInterface
         """
         super().__init__(ui)
         self.__ui = ui
@@ -64,7 +67,8 @@
         """
         Public method to activate this plugin.

-        @return tuple of None and activation status (boolean)
+        @return tuple of None and activation status
+        @rtype tuple of (None, bool)
         """
         return None, True

@@ -73,3 +77,6 @@
         Public method to deactivate this plugin.
         """
         pass
+
+#
+# eflag: noqa = U200
Documentation/source/Plugin_Apis.PluginApis.html		file \| annotate \| diff \| comparison \| revisions
Documentation/source/index-Plugin_Apis.html		file \| annotate \| diff \| comparison \| revisions
Documentation/source/index.html		file \| annotate \| diff \| comparison \| revisions
Documentation/source/styles.css		file \| annotate \| diff \| comparison \| revisions
PluginApis.epj		file \| annotate \| diff \| comparison \| revisions
PluginApis.py		file \| annotate \| diff \| comparison \| revisions