src/eric7/Plugins/CheckerPlugins/SyntaxChecker/jsonCheckSyntax.py

branch
eric7
changeset 10341
3fdffd9cc21d
parent 10111
049fbbd2253d
child 10439
21c28b0f9e41
diff -r 548b4c7f410e -r 3fdffd9cc21d src/eric7/Plugins/CheckerPlugins/SyntaxChecker/jsonCheckSyntax.py
--- a/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/jsonCheckSyntax.py	Fri Nov 24 14:59:26 2023 +0100
+++ b/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/jsonCheckSyntax.py	Sat Nov 25 18:19:21 2023 +0100
@@ -17,7 +17,7 @@
     Initialize the service and return the entry point.
 
     @return the entry point for the background client
-    @rtype func
+    @rtype function
     """
     return jsonSyntaxCheck
 
@@ -27,7 +27,7 @@
     Initialize the batch service and return the entry point.
 
     @return the entry point for the background client
-    @rtype func
+    @rtype function
     """
     return jsonSyntaxBatchCheck
 
@@ -40,11 +40,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 __jsonSyntaxCheck(file, codestring)
 
@@ -53,14 +52,14 @@
     """
     Module function to check syntax for a batch of files.
 
-    @param argumentsList list of arguments tuples as given for yamlSyntaxCheck
+    @param argumentsList list of arguments tuples as given for jsonSyntaxCheck
     @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
     """
@@ -152,11 +151,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:

eric ide

mercurial