From: Markus Lehtonen <markus.lehtonen@linux.intel.com>
Date: Thu, 5 Sep 2013 15:30:07 +0000 (+0300)
Subject: tests: add some docstrings to git submodule tests
X-Git-Tag: debian/0.6.4~8
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f858f8754f400fcf7bb7d3199fcb62634334aba7;p=tools%2Fgit-buildpackage.git

tests: add some docstrings to git submodule tests

Change-Id: I0ba9e6b59e2a819b5cde1be6fbb53b8ecbb67025
Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
---

diff --git a/tests/04_test_submodules.py b/tests/04_test_submodules.py
index 4a9ff399..6e84bdeb 100644
--- a/tests/04_test_submodules.py
+++ b/tests/04_test_submodules.py
@@ -25,6 +25,7 @@ tmpdir = None
 testfile_name = "testfile"
 
 class Submodule(object):
+    """Class representing remote repo for Git submodule"""
     def __init__(self, name, tmpdir):
         self.name = name
         self.dir = os.path.join(tmpdir, name)
@@ -32,6 +33,7 @@ class Submodule(object):
 
 
 def setup():
+    """Test module setup"""
     global repo, repodir, submodules, tmpdir
 
     tmpdir = context.new_tmpdir(__name__)
@@ -45,6 +47,7 @@ def setup():
 
 
 def teardown():
+    """Test module teardown"""
     context.teardown()
 
 def test_empty_has_submodules():
@@ -53,6 +56,7 @@ def test_empty_has_submodules():
 
 
 def _add_dummy_data(repo, msg):
+    """Commit dummy data to a Git repository"""
     shutil.copy(".git/HEAD", testfile_name)
     repo.add_files('.', force=True)
     repo.commit_all(msg)