添加 git 注释提示

Author: zhenwei-li

src/com/dvsnier/git/git.py

@@ -10,6 +10,11 @@ def __init__(self):
         super(Git, self).__init__()
 
     def config(self, output_dir_name='git', file_name='vcs'):
-        'the configure logging modules'
+        '''
+            the configure logging modules
+            note:
+                1. the currently, only one process instance log object is supported.
+                2. the following consideration is to support multi process and multi instance log objects
+        '''
         kwargs = {'output_dir_name': output_dir_name, 'file_name': file_name}
         logging_conf(kwargs)

tests/com/dvsnier/git/test_git.py

@@ -16,15 +16,19 @@ def setUp(self):
         return super(Test_Git, self).setUp()
 
     def test_config(self):
+        ''' the test config
+            note:
+                    1. the currently, only one process instance log object is supported.
+                    2. the following consideration is to support multi process and multi instance log objects
+        '''
         git = Git()
         self.assertIsNotNone(git, 'test_config is error.')
         git.config()
         # git.config(output_dir_name='test_git')
         # git.config(file_name='record')
         # git.config(output_dir_name='test_git', file_name='record')
         logging.warn('the test config is succeed.')
-        print "the test config is succeed."
-        pass
+        print("the test config is succeed.")
 
     def tearDown(self):
         return super(Test_Git, self).tearDown()