Sat, 16 Jan 2021 16:50:00 +0100
Updated source code documentation with the new tags.
--- a/eric6/DebugClients/Python/DebugVariables.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/DebugClients/Python/DebugVariables.py Sat Jan 16 16:50:00 2021 +0100 @@ -74,8 +74,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ names = dir(var) if not names and hasattr(var, "__members__"): @@ -151,8 +152,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0 @@ -216,8 +218,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0 @@ -314,8 +317,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0 @@ -404,8 +408,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0 @@ -496,8 +501,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0 @@ -579,8 +585,9 @@ @param var variable to be converted @type any - @return dictionary containing the variable attributes - @rtype dict + @yield tuple containing the batch start index and a dictionary + containing the variable attributes + @ytype tuple of (int, dict) """ d = {} start = count = 0
--- a/eric6/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/MiscellaneousChecker.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/MiscellaneousChecker.py Sat Jan 16 16:50:00 2021 +0100 @@ -28,8 +28,8 @@ @param node node to assemble call path for @type ast.Node - @return call path components - @rtype str + @yield call path components + @ytype str """ if isinstance(node, ast.Attribute): for v in composeCallPath(node.value):
--- a/eric6/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py Sat Jan 16 16:50:00 2021 +0100 @@ -93,8 +93,8 @@ Private method to scan the given AST tree. @param node AST tree node to scan - @return tuple giving line number, offset within line, code and - checker function + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ for error in self.__visitNode(node): yield error @@ -109,8 +109,8 @@ Private method to inspect the given AST node. @param node AST tree node to inspect - @return tuple giving line number, offset within line, code and - checker function + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ if isinstance(node, ast.ClassDef): self.__tagClassFunctions(node) @@ -229,8 +229,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ if isinstance(node, (ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef)): @@ -278,8 +278,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ if not self.CamelcaseRegexp.match(node.name): yield self.__error(node, "N801") @@ -297,8 +297,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ functionType = getattr(node, "function_type", "function") name = node.name @@ -319,8 +319,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ if node.args.kwarg is not None: kwarg = node.args.kwarg.arg @@ -366,8 +366,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ for parentFunc in reversed(parents): if isinstance(parentFunc, ast.ClassDef): @@ -392,8 +392,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ if self.__filename: moduleName = os.path.splitext(os.path.basename(self.__filename))[0] @@ -415,8 +415,8 @@ @param node AST note to check @param parents list of parent nodes - @return tuple giving line number, offset within line and error code - (integer, integer, string) + @yield tuple giving line number, offset within line and error code + @ytype tuple of (int, int, str) """ for name in node.names: if not name.asname:
--- a/eric6/Project/QuickFindFileDialog.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/Project/QuickFindFileDialog.py Sat Jan 16 16:50:00 2021 +0100 @@ -135,8 +135,8 @@ """ Private method to generate a set of locations that can be searched. - @return yields set of files in our project... - @rtype str + @yield set of files in our project + @ytype str """ for typ in ["SOURCES", "FORMS", "INTERFACES", "PROTOCOLS", "RESOURCES", "TRANSLATIONS", "OTHERS"]:
--- a/eric6/UI/CompareDialog.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/UI/CompareDialog.py Sat Jan 16 16:50:00 2021 +0100 @@ -34,8 +34,7 @@ @param a first sequence of lines (list of strings) @param b second sequence of lines (list of strings) @param linenumberwidth width (in characters) of the linenumbers (integer) - @return a generator yielding tuples of differences. The tuple is composed - of strings as follows. + @yield tuples of differences. Each tuple is composed of strings as follows. <ul> <li>opcode -- one of e, d, i, r for equal, delete, insert, replace</li> @@ -44,7 +43,9 @@ <li>lineno b -- linenumber of sequence b</li> <li>line b -- line of sequence b</li> </ul> + @ytype tuple of (str, str, str, str, str) """ + # __IGNORE_WARNING_D234r__ def removeMarkers(line): """ Internal function to remove all diff markers.
--- a/eric6/WebBrowser/SafeBrowsing/SafeBrowsingUrl.py Sat Jan 16 16:32:01 2021 +0100 +++ b/eric6/WebBrowser/SafeBrowsing/SafeBrowsingUrl.py Sat Jan 16 16:50:00 2021 +0100 @@ -39,8 +39,8 @@ Public method to get the hashes of all possible permutations of the URL in canonical form. - @return generator for the URL hashes - @rtype generator of bytes + @yield URL hashes + @ytype bytes """ for variant in self.permutations(self.canonical()): urlHash = self.digest(variant) @@ -133,8 +133,8 @@ @param url URL string to be permuted @type str - @return generator of permuted URL strings - @rtype generator of str + @yield permutated URL strings + @ytype str """ def hostPermutations(host): """ @@ -142,8 +142,8 @@ @param host host name @type str - @return generator of permuted host names - @rtype generator of str + @yield permutated host names + @ytype str """ if re.match(r'\d+\.\d+\.\d+\.\d+', host): yield host @@ -161,8 +161,8 @@ @param path path to be processed @type str - @return generator of permuted paths - @rtype generator of str + @yield permutated paths + @ytype str """ yield path query = None