Remove inappropriate class variables, add instance variable documentation

[rarslave2.git] / rarslave.py

diff --git a/rarslave.py b/rarslave.py
index 97a100a..0d25883 100644 (file)
--- a/rarslave.py
+++ b/rarslave.py
@@ -20,8 +20,14 @@ options = None
 
 class RarslaveExtractor (object):
 
-       type = None
-       heads = []
+       # Instance Variables
+       # ==========================================================================
+       # dir                                   -- The directory in which this set lives
+       # p2files                               -- All PAR2 files in this set
+       # name_matched_files    -- Files in this set, matched by name only
+       # prot_matched_files    -- Files in this set, matched by parsing PAR2 files only
+       # type                                  -- This set's type
+       # heads                                 -- The heads to be extracted
 
        def __init__ (self, dir, p2files, name_files, prot_files):
 
@@ -223,12 +229,14 @@ class RarslaveExtractor (object):
 
 class PAR2Set (object):
 
-       dir = None
-       p2file = None # The starting par2
-       basename = None # The p2file's basename
-       all_p2files = []
-       name_matched_files = [] # Files that match by basename of the p2file
-       prot_matched_files = [] # Files that match by being protected members
+       # Instance Variables
+       # ==========================================================================
+       # dir                                   -- The directory this set lives in
+       # p2file                                -- The starting PAR2 file
+       # basename                              -- The basename of the set, guessed from the PAR2 file
+       # all_p2files                   -- All PAR2 files of the set, guessed from the PAR2 file name only
+       # name_matched_files    -- Files in this set, guessed by name only
+       # prot_matched_files    -- Files in this set, guessed by parsing the PAR2 only
 
        def __init__ (self, dir, p2file):
                assert os.path.isdir (dir)