commit: 548265bd0b9e3890ad030e57fccc33e240f62e7b
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org>
AuthorDate: Thu Sep 24 16:18:45 2015 +0000
Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org>
CommitDate: Thu Sep 24 16:18:45 2015 +0000
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=548265bd
repoman/qa_data.py: Update docstrings
pym/repoman/qa_data.py | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/pym/repoman/qa_data.py b/pym/repoman/qa_data.py
index a68a53f..b26559c 100644
--- a/pym/repoman/qa_data.py
+++ b/pym/repoman/qa_data.py
@@ -354,14 +354,19 @@ def format_qa_output(
formatter, fails, dofull, dofail, options, qawarnings):
"""Helper function that formats output properly
- Args:
- formatter - a subclass of Formatter
- fails - a dict of qa status failures
- dofull - boolean to print full results or a summary
- dofail - boolean to decide if failure was hard or soft
-
- Returns:
- None (modifies formatter)
+ @param formatter: an instance of Formatter
+ @type formatter: Formatter
+ @param fails: dict of qa status failures
+ @type fails: dict
+ @param dofull: Whether to print full results or a summary
+ @type dofull: boolean
+ @param dofail: Whether failure was hard or soft
+ @type dofail: boolean
+ @param options: The command-line options provided to repoman
+ @type options: Namespace
+ @param qawarnings: the set of warning types
+ @type qawarnings: set
+ @return: None (modifies formatter)
"""
full = options.mode == 'full'
# we only want key value pairs where value > 0
@@ -398,8 +403,6 @@ def format_qa_output_column(
@param formatter: an instance of Formatter
@type formatter: Formatter
- @param path: dict of qa status items
- @type path: dict
@param fails: dict of qa status failures
@type fails: dict
@param dofull: Whether to print full results or a summary
