status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-02 03:41:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed links to github docs. [#2009]

Browse Source
This commit is contained in:
Mark Walker
2021-07-31 02:34:34 +01:00
parent 83d6e0719c
commit ab36b89aa5
45 changed files with 307 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files
github/MainClass.py
+28 -28
View File
@@ -195,7 +195,7 @@ class Github:
"""
Rate limit status for different resources (core/search/graphql).
:calls: `GET /rate_limit <http://docs.github.com/en/rest/reference/rate_limit>`_
:calls: `GET /rate_limit <https://docs.github.com/en/rest/reference/rate-limit>`_
:rtype: :class:`github.RateLimit.RateLimit`
"""
headers, data = self.__requester.requestJsonAndCheck("GET", "/rate_limit")
@@ -210,7 +210,7 @@ class Github:
def get_license(self, key=github.GithubObject.NotSet):
"""
:calls: `GET /license/{license} <https://docs.github.com/en/rest/reference/licenses#get-an-individual-license>`_
:calls: `GET /license/{license} <https://docs.github.com/en/rest/reference/licenses#get-a-license>`_
:param key: string
:rtype: :class:`github.License.License`
"""
@@ -221,7 +221,7 @@ class Github:
def get_licenses(self):
"""
:calls: `GET /licenses <https://docs.github.com/en/rest/reference/licenses#list-all-licenses>`_
:calls: `GET /licenses <https://docs.github.com/en/rest/reference/licenses#get-all-commonly-used-licenses>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.License.License`
"""
@@ -233,7 +233,7 @@ class Github:
def get_events(self):
"""
:calls: `GET /events <https://docs.github.com/en/rest/reference/activity/events#list-public-events>`_
:calls: `GET /events <https://docs.github.com/en/rest/reference/activity#list-public-events>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
"""
@@ -243,7 +243,7 @@ class Github:
def get_user(self, login=github.GithubObject.NotSet):
"""
:calls: `GET /users/{user} <http://docs.github.com/en/rest/reference/users>`_ or `GET /user <http://docs.github.com/en/rest/reference/users>`_
:calls: `GET /users/{user} <https://docs.github.com/en/rest/reference/users>`_ or `GET /user <https://docs.github.com/en/rest/reference/users>`_
:param login: string
:rtype: :class:`github.NamedUser.NamedUser` or :class:`github.AuthenticatedUser.AuthenticatedUser`
"""
@@ -262,7 +262,7 @@ class Github:
def get_user_by_id(self, user_id):
"""
:calls: `GET /user/{id} <http://docs.github.com/en/rest/reference/users>`_
:calls: `GET /user/{id} <https://docs.github.com/en/rest/reference/users>`_
:param user_id: int
:rtype: :class:`github.NamedUser.NamedUser`
"""
@@ -274,7 +274,7 @@ class Github:
def get_users(self, since=github.GithubObject.NotSet):
"""
:calls: `GET /users <http://docs.github.com/en/rest/reference/users>`_
:calls: `GET /users <https://docs.github.com/en/rest/reference/users>`_
:param since: integer
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
@@ -288,7 +288,7 @@ class Github:
def get_organization(self, login):
"""
:calls: `GET /orgs/{org} <http://docs.github.com/en/rest/reference/orgs>`_
:calls: `GET /orgs/{org} <https://docs.github.com/en/rest/reference/orgs>`_
:param login: string
:rtype: :class:`github.Organization.Organization`
"""
@@ -300,7 +300,7 @@ class Github:
def get_organizations(self, since=github.GithubObject.NotSet):
"""
:calls: `GET /organizations <http://docs.github.com/en/rest/reference/orgs#list-all-organizations>`_
:calls: `GET /organizations <https://docs.github.com/en/rest/reference/orgs#list-organizations>`_
:param since: integer
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Organization.Organization`
"""
@@ -317,7 +317,7 @@ class Github:
def get_repo(self, full_name_or_id, lazy=False):
"""
:calls: `GET /repos/{owner}/{repo} <http://docs.github.com/en/rest/reference/repos>`_ or `GET /repositories/{id} <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo} <https://docs.github.com/en/rest/reference/repos>`_ or `GET /repositories/{id} <https://docs.github.com/en/rest/reference/repos>`_
:rtype: :class:`github.Repository.Repository`
"""
assert isinstance(full_name_or_id, (str, int)), full_name_or_id
@@ -334,7 +334,7 @@ class Github:
self, since=github.GithubObject.NotSet, visibility=github.GithubObject.NotSet
):
"""
:calls: `GET /repositories <http://docs.github.com/en/rest/reference/repos#list-all-public-repositories>`_
:calls: `GET /repositories <https://docs.github.com/en/rest/reference/repos#list-public-repositories>`_
:param since: integer
:param visibility: string ('all','public')
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`
@@ -368,7 +368,7 @@ class Github:
def get_project_column(self, id):
"""
:calls: `GET /projects/columns/{column_id} <https://docs.github.com/en/rest/reference/projects/columns#get-a-project-column>`_
:calls: `GET /projects/columns/{column_id} <https://docs.github.com/en/rest/reference/projects#get-a-project-column>`_
:rtype: :class:`github.ProjectColumn.ProjectColumn`
:param id: integer
"""
@@ -383,7 +383,7 @@ class Github:
def get_gist(self, id):
"""
:calls: `GET /gists/{id} <http://docs.github.com/en/rest/reference/gists>`_
:calls: `GET /gists/{id} <https://docs.github.com/en/rest/reference/gists>`_
:param id: string
:rtype: :class:`github.Gist.Gist`
"""
@@ -393,7 +393,7 @@ class Github:
def get_gists(self, since=github.GithubObject.NotSet):
"""
:calls: `GET /gists/public <http://docs.github.com/en/rest/reference/gists>`_
:calls: `GET /gists/public <https://docs.github.com/en/rest/reference/gists>`_
:param since: datetime.datetime format YYYY-MM-DDTHH:MM:SSZ
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Gist.Gist`
"""
@@ -415,7 +415,7 @@ class Github:
**qualifiers,
):
"""
:calls: `GET /search/repositories <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/repositories <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param sort: string ('stars', 'forks', 'updated')
:param order: string ('asc', 'desc')
@@ -460,7 +460,7 @@ class Github:
**qualifiers,
):
"""
:calls: `GET /search/users <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/users <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param sort: string ('followers', 'repositories', 'joined')
:param order: string ('asc', 'desc')
@@ -501,7 +501,7 @@ class Github:
**qualifiers,
):
"""
:calls: `GET /search/issues <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/issues <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param sort: string ('comments', 'created', 'updated')
:param order: string ('asc', 'desc')
@@ -540,7 +540,7 @@ class Github:
**qualifiers,
):
"""
:calls: `GET /search/code <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/code <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param sort: string ('indexed')
:param order: string ('asc', 'desc')
@@ -589,7 +589,7 @@ class Github:
**qualifiers,
):
"""
:calls: `GET /search/commits <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/commits <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param sort: string ('author-date', 'committer-date')
:param order: string ('asc', 'desc')
@@ -629,7 +629,7 @@ class Github:
def search_topics(self, query, **qualifiers):
"""
:calls: `GET /search/topics <http://docs.github.com/en/rest/reference/search>`_
:calls: `GET /search/topics <https://docs.github.com/en/rest/reference/search>`_
:param query: string
:param qualifiers: keyword dict query qualifiers
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Topic.Topic`
@@ -657,7 +657,7 @@ class Github:
def render_markdown(self, text, context=github.GithubObject.NotSet):
"""
:calls: `POST /markdown <http://docs.github.com/en/rest/reference/markdown>`_
:calls: `POST /markdown <https://docs.github.com/en/rest/reference/markdown>`_
:param text: string
:param context: :class:`github.Repository.Repository`
:rtype: string
@@ -677,7 +677,7 @@ class Github:
def get_hook(self, name):
"""
:calls: `GET /hooks/{name} <http://docs.github.com/en/rest/reference/repos#hooks>`_
:calls: `GET /hooks/{name} <https://docs.github.com/en/rest/reference/repos#webhooks>`_
:param name: string
:rtype: :class:`github.HookDescription.HookDescription`
"""
@@ -691,7 +691,7 @@ class Github:
def get_hooks(self):
"""
:calls: `GET /hooks <http://docs.github.com/en/rest/reference/repos#hooks>`_
:calls: `GET /hooks <https://docs.github.com/en/rest/reference/repos#webhooks>`_
:rtype: list of :class:`github.HookDescription.HookDescription`
"""
headers, data = self.__requester.requestJsonAndCheck("GET", "/hooks")
@@ -704,7 +704,7 @@ class Github:
def get_gitignore_templates(self):
"""
:calls: `GET /gitignore/templates <http://docs.github.com/en/rest/reference/gitignore>`_
:calls: `GET /gitignore/templates <https://docs.github.com/en/rest/reference/gitignore>`_
:rtype: list of string
"""
headers, data = self.__requester.requestJsonAndCheck(
@@ -714,7 +714,7 @@ class Github:
def get_gitignore_template(self, name):
"""
:calls: `GET /gitignore/templates/{name} <http://docs.github.com/en/rest/reference/gitignore>`_
:calls: `GET /gitignore/templates/{name} <https://docs.github.com/en/rest/reference/gitignore>`_
:rtype: :class:`github.GitignoreTemplate.GitignoreTemplate`
"""
assert isinstance(name, str), name
@@ -727,7 +727,7 @@ class Github:
def get_emojis(self):
"""
:calls: `GET /emojis <http://docs.github.com/en/rest/reference/emojis>`_
:calls: `GET /emojis <https://docs.github.com/en/rest/reference/emojis>`_
:rtype: dictionary of type => url for emoji`
"""
headers, attributes = self.__requester.requestJsonAndCheck("GET", "/emojis")
@@ -753,7 +753,7 @@ class Github:
:param obj: the object to pickle
:param file: the file-like object to pickle to
:param protocol: the `pickling protocol <http://docs.python.org/2.7/library/pickle.html#data-stream-format>`_
:param protocol: the `pickling protocol <https://python.readthedocs.io/en/latest/library/pickle.html#data-stream-format>`_
"""
pickle.dump((obj.__class__, obj.raw_data, obj.raw_headers), file, protocol)
@@ -865,7 +865,7 @@ class GithubIntegration:
def get_installation(self, owner, repo):
"""
:calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation>`_
:calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app>`_
:param owner: str
:param repo: str
:rtype: :class:`github.Installation.Installation`