src/eric7/DebugClients/Python/FlexCompleter.py

branch
eric7
changeset 10417
c6011e501282
parent 9482
a2bc06a54d9d
child 11047
783fc3de315e
--- a/src/eric7/DebugClients/Python/FlexCompleter.py	Sat Dec 16 17:52:02 2023 +0100
+++ b/src/eric7/DebugClients/Python/FlexCompleter.py	Sun Dec 17 17:15:19 2023 +0100
@@ -77,7 +77,8 @@
 
         readline.set_completer(Completer(my_namespace).complete)
 
-        @param namespace The namespace for the completer.
+        @param namespace namespace for the completer
+        @type dict
         @exception TypeError raised to indicate a wrong data structure of
             the namespace object
         """
@@ -100,9 +101,12 @@
         This is called successively with state == 0, 1, 2, ... until it
         returns None.  The completion should begin with 'text'.
 
-        @param text The text to be completed. (string)
-        @param state The state of the completion. (integer)
-        @return The possible completions as a list of strings.
+        @param text text to be completed
+        @type str
+        @param state state of the completion
+        @type int
+        @return possible completions
+        @rtype list of str
         """
         if self.use_main_ns:
             self.namespace = __main__.__dict__
@@ -121,9 +125,12 @@
         """
         Protected method to check for a callable.
 
-        @param val value to check (object)
-        @param word word to ammend (string)
-        @return ammended word (string)
+        @param val value to check
+        @type Any
+        @param word word to amend
+        @type str
+        @return amended word
+        @rtype str
         """
         if callable(val):
             word += "("
@@ -133,9 +140,11 @@
         """
         Public method to compute matches when text is a simple name.
 
-        @param text The text to be completed. (string)
-        @return A list of all keywords, built-in functions and names currently
-        defined in self.namespace that match.
+        @param text text to be completed
+        @type str
+        @return list of all keywords, built-in functions and names currently
+            defined in self.namespace that match
+        @rtype list of str
         """
         matches = []
         seen = {"__builtins__"}
@@ -175,8 +184,10 @@
         <b>WARNING</b>: this can still invoke arbitrary C code, if an object
         with a __getattr__ hook is evaluated.
 
-        @param text The text to be completed. (string)
-        @return A list of all matches.
+        @param text text to be completed
+        @type str
+        @return list of all matches
+        @rtype list of str
         """
         m = re.match(r"(\w+(\.\w+)*)\.(\w*)", text)
         if not m:
@@ -224,8 +235,10 @@
     """
     Module function to retrieve the class members.
 
-    @param klass The class object to be analysed.
-    @return A list of all names defined in the class.
+    @param klass class object to be analyzed
+    @type Any
+    @return list of all names defined in the class
+    @rtype list of str
     """
     ret = dir(klass)
     if hasattr(klass, "__bases__"):

eric ide

mercurial