[codeface] [PATCH 15/19] Whitespace cleanup and docstring extension in codeface/linktype.py

  • From: Andreas Ringlstetter <andreas.ringlstetter@xxxxxxxxxxxxxxxxxxxx>
  • To: <codeface@xxxxxxxxxxxxx>
  • Date: Tue, 16 Feb 2016 13:40:04 +0100

From: Benjamin Hiefner <benjamin.hiefner@xxxxxxxxxxxxxxxxxxxx>

Signed-off-by: Benjamin Hiefner <benjamin.hiefner@xxxxxxxxxxxxxxxxxxxx>
---
 codeface/linktype.py | 60 +++++++++++++++++++++++++++++++---------------------
 1 file changed, 36 insertions(+), 24 deletions(-)

diff --git a/codeface/linktype.py b/codeface/linktype.py
index be45508..9a50153 100644
--- a/codeface/linktype.py
+++ b/codeface/linktype.py
@@ -1,26 +1,29 @@
-## This file is part of Codeface. Codeface is free software: you can
-## redistribute it and/or modify it under the terms of the GNU General Public
-## License as published by the Free Software Foundation, version 2.
-##
-## This program is distributed in the hope that it will be useful, but WITHOUT
-## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS
-## FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-## details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-##
-## Copyright 2013 by Siemens AG, Wolfgang Mauerer 
<wolfgang.mauerer@xxxxxxxxxxx>
-## Copyright 2014 by Matthias Dittrich <matthi.d@xxxxxxxxx>
-## All Rights Reserved.
-
-__author__ = 'drag0on'
-
-
-#enum-like class to distinguish between the various
-#methods used to link individuals
-class LinkType:
+# This file is part of Codeface. Codeface is free software: you can
+# redistribute it and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, version 2.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Copyright 2013 by Siemens AG, Wolfgang Mauerer <wolfgang.mauerer@xxxxxxxxxxx>
+# Copyright 2014 by Matthias Dittrich <matthi.d@xxxxxxxxx>
+# All Rights Reserved.
+"""
+Module for containing the LinkType class
+"""
+__author__ = "drag0on"
+
+
+class LinkType(object):
+    """ enum-like class to distinguish between the various
+    methods used to link individuals
+    """
     tag = "tag"
     proximity = "proximity"
     committer2author = "committer2author"
@@ -33,9 +36,18 @@ class LinkType:
 
     @staticmethod
     def get_all_link_types():
+        """
+
+        Returns: all link types
+
+        """
         return LinkType._all_link_types
 
     @staticmethod
     def get_tag_types():
+        """
+
+        Returns: List containing the tag types for committer2author 
relationship
+        """
         return ["Signed-off-by", "Acked-by", "CC", "Reviewed-by",
-                "Reported-by", "Tested-by", "Patch"]
\ No newline at end of file
+                "Reported-by", "Tested-by", "Patch"]
-- 
2.7.1


Other related posts: