From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id 729B5139BC6 for ; Thu, 24 Sep 2015 16:20:03 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 6828621C003; Thu, 24 Sep 2015 16:20:00 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 0C5AD21C003 for ; Thu, 24 Sep 2015 16:19:59 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 0E8403402A2 for ; Thu, 24 Sep 2015 16:19:58 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id A409D239 for ; Thu, 24 Sep 2015 16:19:54 +0000 (UTC) From: "Brian Dolbec" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Brian Dolbec" Message-ID: <1443111525.548265bd0b9e3890ad030e57fccc33e240f62e7b.dolsen@gentoo> Subject: [gentoo-commits] proj/portage:master commit in: pym/repoman/ X-VCS-Repository: proj/portage X-VCS-Files: pym/repoman/qa_data.py X-VCS-Directories: pym/repoman/ X-VCS-Committer: dolsen X-VCS-Committer-Name: Brian Dolbec X-VCS-Revision: 548265bd0b9e3890ad030e57fccc33e240f62e7b X-VCS-Branch: master Date: Thu, 24 Sep 2015 16:19:54 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 83c2ca81-9f3a-434f-a1f3-6da85925bc48 X-Archives-Hash: 07afdddd38b0487c4caab3c3cdc72eb3 commit: 548265bd0b9e3890ad030e57fccc33e240f62e7b Author: Brian Dolbec gentoo org> AuthorDate: Thu Sep 24 16:18:45 2015 +0000 Commit: Brian Dolbec gentoo 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