Comments on class RepositoryClient

paicemana/githubclient.py

@@ -2,12 +2,19 @@
 
 
 class RepositoryClient(object):
+    """Class to read and write on GitHub repository"""
 
     def __init__(self, repo_user = 'OSMBrasil', repo_name = 'semanario'):
+        """
+        @params
+        repo_user - name of organization or user
+        repo_name - repository name
+        """
         github = GitHub()
         self.repo = github.repository(repo_user, repo_name)
 
     def milestones_info(self):
+        """Prints information for identification of milestones"""
         s = ''
         for milestone in self.repo.milestones():
             s += 'The milestone "%s" has number=%s\n'\