Mercurial Repositories > eric / file diff

--- a/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/yamlCheckSyntax.py	Fri Nov 24 14:59:26 2023 +0100
+++ b/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/yamlCheckSyntax.py	Sat Nov 25 18:19:21 2023 +0100
@@ -16,7 +16,7 @@
     Initialize the service and return the entry point.
 
     @return the entry point for the background client
-    @rtype func
+    @rtype function
     """
     return yamlSyntaxCheck
 
@@ -26,7 +26,7 @@
     Initialize the batch service and return the entry point.
 
     @return the entry point for the background client
-    @rtype func
+    @rtype function
     """
     return yamlSyntaxBatchCheck
 
@@ -39,11 +39,10 @@
     @type str
     @param codestring string containing the code to check
     @type str
-    @return dictionary with the keys 'error' and 'warnings' which
-            hold a list containing details about the error/ warnings
-            (file name, line number, column, codestring (only at syntax
-            errors), the message, a list with arguments for the message)
-    @rtype dict
+    @return list of dictionaries  with the key 'error' which contain a tuple with
+        details about the syntax error. Each tuple contains the file name, line
+        number, column, code string and the error message.
+    @rtype list of dict
     """
     return __yamlSyntaxCheck(file, codestring)
 
@@ -55,11 +54,11 @@
     @param argumentsList list of arguments tuples as given for yamlSyntaxCheck
     @type list
     @param send reference to send function
-    @type func
+    @type function
     @param fx registered service name
     @type str
     @param cancelled reference to function checking for a cancellation
-    @type func
+    @type function
     @param maxProcesses number of processes to be used
     @type int
     """
@@ -151,11 +150,10 @@
     @type str
     @param codestring string containing the code to check
     @type str
-    @return dictionary with the keys 'error' and 'warnings' which
-            hold a list containing details about the error/ warnings
-            (file name, line number, column, codestring (only at syntax
-            errors), the message, a list with arguments for the message)
-    @rtype dict
+    @return list of dictionaries  with the key 'error' which contain a tuple with
+        details about the syntax error. Each tuple contains the file name, line
+        number, column, code string and the error message.
+    @rtype list of dict
     """
     if codestring:
         try: