diff --git a/github/MainClass.py b/github/MainClass.py index c40b2dc1..eddfd84b 100644 --- a/github/MainClass.py +++ b/github/MainClass.py @@ -126,7 +126,7 @@ class Github(object): """ Don't forget you can access the rate limit returned in headers of last Github API v3 response, by :attr:`github.MainClass.Github.rate_limiting` and :attr:`github.MainClass.Github.rate_limiting_resettime`. - :calls: `GET /rate_limit `_ + :calls: `GET /rate_limit `_ :rtype: :class:`github.RateLimit.RateLimit` """ headers, attributes = self.__requester.requestJsonAndCheck( diff --git a/github/NamedUser.py b/github/NamedUser.py index aa7c5547..55bf65fd 100644 --- a/github/NamedUser.py +++ b/github/NamedUser.py @@ -329,6 +329,7 @@ class NamedUser(github.GithubObject.CompletableGithubObject): self._completeIfNotSet(self._url) return self._NoneIfNotSet(self._url) + # v2: Remove this method def create_gist(self, public, files, description=github.GithubObject.NotSet): """ :calls: `POST /users/:user/gists `_ @@ -529,7 +530,7 @@ class NamedUser(github.GithubObject.CompletableGithubObject): def has_in_following(self, following): """ - :calls: `GET /user/:user/following/:target_user `_ + :calls: `GET /users/:user/following/:target_user `_ :param following: :class:`github.NamedUser.NamedUser` :rtype: bool """ diff --git a/scripts/compare_to_api_ref_doc.py b/scripts/compare_to_api_ref_doc.py index a4c795c1..05c10448 100755 --- a/scripts/compare_to_api_ref_doc.py +++ b/scripts/compare_to_api_ref_doc.py @@ -41,6 +41,9 @@ def parseReference(): undocumentedUrls = [ ("/hooks", "GET"), # Mentioned somewhere ("/hub", "POST"), # Described in content/v3/repos/hooks.md + ("/api/status.json", "GET"), # https://status.github.com/api + ("/api/last-message.json", "GET"), # https://status.github.com/api + ("/api/messages.json", "GET"), # https://status.github.com/api ] uninterestingUrls = [ ("/markdown/raw", "POST"), # Job is done by /markdown => useless in PyGithub @@ -74,7 +77,7 @@ def parseReference(): urls[url] = docUrl for url in undocumentedUrls: - urls[url] = "http://developer.github.com/" + urls[url] = None for url in uninterestingUrls: del urls[url] @@ -112,7 +115,7 @@ def main(): printUrls("called by PyGithub but not existing in Github API v3", set(lib) - set(ref)) for key in set(lib) & set(ref): (url, verb) = key - if lib[key] != ref[key]: + if ref[key] is not None and lib[key] != ref[key] and not lib[key].startswith(ref[key] + "/#"): print "sed -i \"s@:calls: ." + verb + " " + url + " ." + lib[key] + ".._" + "@:calls: \\`" + verb + " " + url + " \\<" + ref[key] + "\\>\\`_@\" github/*.py"