Added warning about default branch to commits.list.

JNRowe · JNRowe · commit 017690e57d87 · 2011-05-27T02:00:47.000+01:00
Closes ask#44.
diff --git a/github2/commits.py b/github2/commits.py
@@ -24,19 +24,18 @@ def __repr__(self):
 
 
 class Commits(GithubCommand):
-    """
-    .. warning::
-        Unfortunately, commits from repositories containing certain characters
-        such as '.' will fail.  This is an issue with the GitHub API, and can't
-        currently be worked around in this library.
-    """
     domain = "commits"
 
     def list(self, project, branch="master", file=None):
         """List commits on a project
 
+        .. warning::
+           Not all projects use ``master`` as their default branch, you can
+           check the value of the ``Repo(project).master_branch`` attribute to
+           determine the default branch of a given repository.
+
         :param str project: project name
-        :param str branch: branch name
+        :param str branch: branch name, or ``master`` if not given
         :param str file: optional file filter
         """
         return self.get_values("list", project, branch, file,
diff --git a/tests/data/github.com,api,v2,json,commits,list,kennethreitz,osxpython.org,master,f245f9d2f5db473934bef7aed73bbdac b/tests/data/github.com,api,v2,json,commits,list,kennethreitz,osxpython.org,master,f245f9d2f5db473934bef7aed73bbdac
diff --git a/tests/test_commits.py b/tests/test_commits.py
@@ -1,8 +1,6 @@
 import _setup
 
-import sys
-
-from nose.tools import (assert_equals, assert_false)
+from nose.tools import assert_equals
 
 import utils
 
@@ -34,21 +32,3 @@ def test_list_with_branch_and_file(self):
         assert_equals(len(commits), 35)
         assert_equals(commits[0].id,
                 '482f657443df4b701137a3025ae08476cddd2b7d')
-
-    def test_list_repo_with_dot(self):
-        """GitHub returns error listing commits in repos containing '.'
-
-        The purpose of this test is to tell us when this issue is fixed
-        upstream.
-        """
-        try:
-            commits = self.client.commits.list('kennethreitz/osxpython.org')
-        except RuntimeError:
-            # The hoop jumping here is for Python 2 & 3 compatibility, it is
-            # also good a sign it may be time to use 2to3 on the tests.
-            e = sys.exc_info()[1]
-            if """'{"error":"Not Found"}'""" not in e.args[0]:
-                raise
-            commits = None
-        assert_false(commits,
-                     "Listing commits with '.' in name is fixed upstream!")
