| 1 |
commit: 548265bd0b9e3890ad030e57fccc33e240f62e7b |
| 2 |
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Thu Sep 24 16:18:45 2015 +0000 |
| 4 |
Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Thu Sep 24 16:18:45 2015 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=548265bd |
| 7 |
|
| 8 |
repoman/qa_data.py: Update docstrings |
| 9 |
|
| 10 |
pym/repoman/qa_data.py | 23 +++++++++++++---------- |
| 11 |
1 file changed, 13 insertions(+), 10 deletions(-) |
| 12 |
|
| 13 |
diff --git a/pym/repoman/qa_data.py b/pym/repoman/qa_data.py |
| 14 |
index a68a53f..b26559c 100644 |
| 15 |
--- a/pym/repoman/qa_data.py |
| 16 |
+++ b/pym/repoman/qa_data.py |
| 17 |
@@ -354,14 +354,19 @@ def format_qa_output( |
| 18 |
formatter, fails, dofull, dofail, options, qawarnings): |
| 19 |
"""Helper function that formats output properly |
| 20 |
|
| 21 |
- Args: |
| 22 |
- formatter - a subclass of Formatter |
| 23 |
- fails - a dict of qa status failures |
| 24 |
- dofull - boolean to print full results or a summary |
| 25 |
- dofail - boolean to decide if failure was hard or soft |
| 26 |
- |
| 27 |
- Returns: |
| 28 |
- None (modifies formatter) |
| 29 |
+ @param formatter: an instance of Formatter |
| 30 |
+ @type formatter: Formatter |
| 31 |
+ @param fails: dict of qa status failures |
| 32 |
+ @type fails: dict |
| 33 |
+ @param dofull: Whether to print full results or a summary |
| 34 |
+ @type dofull: boolean |
| 35 |
+ @param dofail: Whether failure was hard or soft |
| 36 |
+ @type dofail: boolean |
| 37 |
+ @param options: The command-line options provided to repoman |
| 38 |
+ @type options: Namespace |
| 39 |
+ @param qawarnings: the set of warning types |
| 40 |
+ @type qawarnings: set |
| 41 |
+ @return: None (modifies formatter) |
| 42 |
""" |
| 43 |
full = options.mode == 'full' |
| 44 |
# we only want key value pairs where value > 0 |
| 45 |
@@ -398,8 +403,6 @@ def format_qa_output_column( |
| 46 |
|
| 47 |
@param formatter: an instance of Formatter |
| 48 |
@type formatter: Formatter |
| 49 |
- @param path: dict of qa status items |
| 50 |
- @type path: dict |
| 51 |
@param fails: dict of qa status failures |
| 52 |
@type fails: dict |
| 53 |
@param dofull: Whether to print full results or a summary |
Archives