Move rule descriptions to rule class docstrings

common/rulebase.py

@@ -91,8 +91,8 @@ def name(self):
         path = "".join(path.split(".")[:-1])
         return path.replace('_', '.')
 
-    def __init__(self, description):
-        self.description = description
+    def __init__(self):
+        self.description = self.__doc__.strip().splitlines()[0].strip()
         self.messageBuffer=[]
         self.resetErrorCount()
         self.resetWarningCount()

pcb/rules/F5_1.py

@@ -7,11 +7,7 @@
 import cmath
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, "Silkscreen layer requirements")
+    """Silkscreen layer requirements"""
 
     def checkReference(self):
         """

pcb/rules/F5_2.py

@@ -10,11 +10,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, "Fabrication layer requirements")
+    """Fabrication layer requirements"""
 
     # Check for presence of component value
     def checkMissingValue(self):

pcb/rules/F5_3.py

@@ -16,11 +16,7 @@
 from boundingbox import BoundingBox
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, "Courtyard layer requirements")
+    """Courtyard layer requirements"""
 
     # Get the superposed boundary of pads and fab layer
     def getFootprintBounds(self):
@@ -214,4 +210,4 @@ def fix(self):
                 self.module.addRectangle(
                     [cy['x'], cy['y']],
                     [cy['x'] + cy['width'], cy['y'] + cy['height']],
-                    'F.CrtYd', KLC_CRTYD_WIDTH)
+                    'F.CrtYd', KLC_CRTYD_WIDTH)

pcb/rules/F6_1.py

@@ -5,11 +5,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'For surface-mount devices, placement type must be set to "Surface Mount"')
+    """Footprint placement type must be set to surface mount"""
 
     def check(self):
         """

pcb/rules/F6_2.py

@@ -5,11 +5,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args,'For surface-mount devices, footprint anchor is placed in the middle of the footprint (IPC-7351).')
+    """Footprint anchor should be placed in the middle of the component body"""
 
     def check(self):
         """

pcb/rules/F6_3.py

@@ -3,11 +3,10 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
+    """Pad requirements for SMD footprints"""
+
     def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Pad requirements for SMD footprints')
+        super(Rule, self).__init__(module, args)
 
         self.required_layers = ["Cu", "Paste", "Mask"]
         self.sides = ["F.", "B."]

pcb/rules/F7_1.py

@@ -5,11 +5,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'For through-hole devices, placement type must be set to "Through Hole"')
+    """Footprint placement type must be set to Through Hole"""
 
     def check(self):
         """

pcb/rules/F7_2.py

@@ -3,11 +3,10 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
+    """Footprint anchor should placed at the location of Pin-1"""
+
     def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'For through-hole components, footprint anchor is set on pad 1')
+        super(Rule, self).__init__(module, args)
 
         self.pin1_position = []
         self.pin1_count = 0

pcb/rules/F7_3.py

@@ -3,11 +3,10 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
+    """Pin 1 should be rectangular, and other pads circular or oval"""
+
     def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Pad 1 should be denoted by rectangular pad')
+        super(Rule, self).__init__(module, args)
 
         self.names = ['1', 'A', 'A1', 'P1', 'PAD1']
         self.pad_1_shapes = ['rect', 'roundrect']

pcb/rules/F7_4.py

@@ -3,11 +3,10 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
+    """Pad requirements for THT footprints"""
+
     def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Pad requirements for THT footprints')
+        super(Rule, self).__init__(module, args)
 
         self.required_layers = ["*.Cu","*.Mask"]
 

pcb/rules/F7_5.py

@@ -5,11 +5,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Annular ring must be at least 0.15mm')
+    """Minimum annular ring width"""
 
     def checkPad(self, pad):
         if not 'size' in pad['drill']:

pcb/rules/F7_6.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Minimum hole drill size')
+    """Minimum hole diameter"""
 
     def checkPad(self, pad):
 

pcb/rules/F9_1.py

@@ -4,11 +4,7 @@
 import os
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Footprint metadata must be filled as appropriate')
+    """Footprint meta-data is filled in as appropriate"""
 
     def checkDocs(self):
         mod = self.module

pcb/rules/F9_2.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Footprint properties should be left to default values.')
+    """Footprint properties are as default values unless otherwise required in datasheet"""
 
     def check(self):
         """

pcb/rules/F9_3.py

@@ -7,9 +7,7 @@
 SYSMOD_PREFIX = "${KISYS3DMOD}/"
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad_mod files.
-    """
+    """Footprint 3D model requirements"""
 
     # Regular expression for suffixes that shouldn't be in the model file
     suffix_re = (
@@ -21,9 +19,6 @@ class Rule(KLCRule):
         ')'
     )
 
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, '3D model settings')
-
     def checkModel(self, model):
 
         error = False

pcb/rules/G1_1.py

@@ -4,11 +4,10 @@
 import re
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
+    """Only standard characters are used for naming libraries and components"""
+
     def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Illegal characters in footprint name')
+        super(Rule, self).__init__(module, args)
         # Set of allowed chars. Some characters need to be escaped.
         allowed_chars = "a-zA-Z0-9_\-\.,\+"
         self.pattern = re.compile('^['+allowed_chars+']+$')

pcb/rules/G1_7.py

@@ -4,11 +4,7 @@
 import platform
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, module, args):
-        super(Rule, self).__init__(module, args, 'Library files must use Unix-style line endings (LF)')
+    """Library files use Unix style line endings"""
 
     def check(self):
 

pcb/rules/rule.py

@@ -78,12 +78,13 @@ def graphItemString(graph, layer=False, width=False):
     return shapeText + layerText + widthText
 
 class KLCRule(KLCRuleBase):
+    """A base class to represent a KLC rule
+
+    Create the methods check and fix to use with the kicad_mod files.
     """
-    A base class to represent a KLC rule
-    """
-    def __init__(self, module, args, description):
+    def __init__(self, module, args):
 
-        KLCRuleBase.__init__(self, description)
+        KLCRuleBase.__init__(self)
 
         self.module = module
         self.args = args
@@ -99,4 +100,4 @@ def fix(self):
     def fixmore(self):
         if self.needsFixMore:
             self.info("fixmore not supported")
-        return
+        return

schlib/rules/EC01.py

@@ -4,11 +4,7 @@
 import re
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'General pin number checking')
+    """General pin number checking"""
 
     def checkPinNames(self):
         self.wrong_pin_numbers = []

schlib/rules/EC02.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Check part reference, name and footprint position and alignment')
+    """Check part reference, name and footprint position and alignment"""
 
     def check(self):
         """

schlib/rules/G1_1.py

@@ -4,11 +4,7 @@
 import string
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Illegal characters in symbol name')
+    """Only standard characters are used for naming libraries and components"""
 
     def check(self):
 

schlib/rules/S3_1.py

@@ -4,11 +4,7 @@
 import math
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Origin is centered on the middle of the symbol')
+    """Origin is centered on the middle of the symbol"""
 
     def check(self):
         """

schlib/rules/S3_2.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Text fields should use common size of 50mils, but labels and numbers may use text size as low as 20mil if required')
+    """Text fields should use a common text size of 50mils"""
 
     def check(self):
         """

schlib/rules/S3_3.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Symbol outline and fill requirements')
+    """Symbol outline and fill requirements"""
 
     def check(self):
         """

schlib/rules/S3_6.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Pin name position offset')
+    """Pin name position offset"""
 
     def check(self):
 

schlib/rules/S4_1.py

@@ -3,11 +3,7 @@
 from rules.rule import *
 
 class Rule(KLCRule):
-    """
-    Create the methods check and fix to use with the kicad lib files.
-    """
-    def __init__(self, component):
-        super(Rule, self).__init__(component, 'Pin requirements')
+    """General pin requirements"""
 
     def checkPinOrigin(self, gridspacing=100):
         self.violating_pins = []
@@ -131,4 +127,4 @@ def fix(self):
             pass
 
         if self.checkPinLength():
-            pass
+            pass