From c27fb91966840d2908123eeba5cef610b7ec9f7f Mon Sep 17 00:00:00 2001 From: Floyd Hightower Date: Tue, 23 Mar 2021 19:17:28 -0400 Subject: [PATCH] Updating links to Github documentation for deploy keys (#1850) * Updating links to Github documentation for deploy keys There are a couple of links to http://developer.github.com/v3/repos/keys/ and I believe these should be going to http://developer.github.com/v3/repos/#deploy-keys. I've updated the docstrings in this file appropriately. --- github/Repository.py | 6 +++--- github/RepositoryKey.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/github/Repository.py b/github/Repository.py index 989f0441..d1db84da 100644 --- a/github/Repository.py +++ b/github/Repository.py @@ -1222,7 +1222,7 @@ class Repository(github.GithubObject.CompletableGithubObject): def create_key(self, title, key, read_only=False): """ - :calls: `POST /repos/:owner/:repo/keys `_ + :calls: `POST /repos/:owner/:repo/keys `_ :param title: string :param key: string :param read_only: bool @@ -2598,7 +2598,7 @@ class Repository(github.GithubObject.CompletableGithubObject): def get_key(self, id): """ - :calls: `GET /repos/:owner/:repo/keys/:id `_ + :calls: `GET /repos/:owner/:repo/keys/:id `_ :param id: integer :rtype: :class:`github.RepositoryKey.RepositoryKey` """ @@ -2612,7 +2612,7 @@ class Repository(github.GithubObject.CompletableGithubObject): def get_keys(self): """ - :calls: `GET /repos/:owner/:repo/keys `_ + :calls: `GET /repos/:owner/:repo/keys `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.RepositoryKey.RepositoryKey` """ return github.PaginatedList.PaginatedList( diff --git a/github/RepositoryKey.py b/github/RepositoryKey.py index 2ff72e14..4e7f9e6b 100644 --- a/github/RepositoryKey.py +++ b/github/RepositoryKey.py @@ -38,7 +38,7 @@ import github.GithubObject class RepositoryKey(github.GithubObject.CompletableGithubObject): """ - This class represents RepositoryKeys. The reference can be found here http://developer.github.com/v3/repos/keys/ + This class represents RepositoryKeys. The reference can be found here http://developer.github.com/v3/repos/#deploy-keys """ def __repr__(self): @@ -102,7 +102,7 @@ class RepositoryKey(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:owner/:repo/keys/:id `_ + :calls: `DELETE /repos/:owner/:repo/keys/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)