[codeface] Re: [PATCH 10/19] PEP8 and made class a new-style class

  • From: Wolfgang Mauerer <wolfgang.mauerer@xxxxxxxxxxxxxxxxx>
  • To: <codeface@xxxxxxxxxxxxx>
  • Date: Tue, 16 Feb 2016 17:12:13 +0100



Am 16/02/2016 um 15:53 schrieb Andreas Ringlstetter:



Am 16.02.2016 um 15:25 schrieb Wolfgang Mauerer:
The commit description is very very generic.

Am 16/02/2016 um 13:39 schrieb Andreas Ringlstetter:
From: Benjamin Hiefner <benjamin.hiefner@xxxxxxxxxxxxxxxxxxxx>

Signed-off-by: Benjamin Hiefner <benjamin.hiefner@xxxxxxxxxxxxxxxxxxxx>
---
 codeface/commit.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/codeface/commit.py b/codeface/commit.py
index 1376927..7c5e2f4 100644
--- a/codeface/commit.py
+++ b/codeface/commit.py
@@ -23,7 +23,8 @@ Contains class commit with all required members
 """
 #TODO insert comments into docstrings
 
-class Commit:
+

why an additional newline?
+class Commit(object):
     """Keywords to identify corrective commits
     Ref: A. Mockus and L. G. Votta, Identifying Reasons for Software
     Changes Using Historic Databases
@@ -164,6 +165,9 @@ class Commit:
     def checkIfCorrective(self, descr):
         """Check if commit description contains keywords that indicate a
         corrective commit
+
+        Args:
+            descr:

Is this required if there are no arguments?

No, it's not mandatory at all, actually. This one is still lacking the
typehint and description though.

if we make a change, there should also be a description. Just inserting
identical non-information twice is kind of redundant. --WM

         """
         for line in descr:
             contains_keyword = [keyword in line.lower()




Other related posts:

  1. Home
  2. codeface
  3. Archive
  4. 02-2016