Update most URLs to docs.github.com (#1896)

Now that GitHub have moved their documentation from
developer.github.com, we should update our links. I have also tried to
update the call strings to their new format, but since it was done via
regex, some of them may not match exactly.
This commit is contained in:
Steve Kowalik
2021-03-26 20:43:48 +11:00
committed by GitHub
parent ad124ef481
commit babcbcd04f
80 changed files with 529 additions and 530 deletions
+4 -4
View File
@@ -28,7 +28,7 @@ import github.PullRequest
class WorkflowRun(github.GithubObject.CompletableGithubObject):
"""
This class represents Workflow Runs. The reference can be found here https://developer.github.com/v3/actions/workflow-runs/
This class represents Workflow Runs. The reference can be found here https://docs.github.com/en/rest/reference/actions#workflow-runs
"""
def __repr__(self):
@@ -220,7 +220,7 @@ class WorkflowRun(github.GithubObject.CompletableGithubObject):
def cancel(self):
"""
:calls: `POST /repos/:owner/:repo/actions/runs/:run_id/cancel <https://developer.github.com/v3/actions/workflow-runs/>`_
:calls: `POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel <https://docs.github.com/en/rest/reference/actions#workflow-runs>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson("POST", self.cancel_url)
@@ -228,7 +228,7 @@ class WorkflowRun(github.GithubObject.CompletableGithubObject):
def rerun(self):
"""
:calls: `POST /repos/:owner/:repo/actions/runs/:run_id/rerun <https://developer.github.com/v3/actions/workflow-runs/>`_
:calls: `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun <https://docs.github.com/en/rest/reference/actions#workflow-runs>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson("POST", self.rerun_url)
@@ -236,7 +236,7 @@ class WorkflowRun(github.GithubObject.CompletableGithubObject):
def timing(self):
"""
:calls: `GET /repos/:owner/:repo/actions/runs/:run_id/timing <https://developer.github.com/v3/actions/workflow-runs/>`_
:calls: `GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing <https://docs.github.com/en/rest/reference/actions#workflow-runs>`_
:rtype: namedtuple with billable and run_duration_ms members
"""
headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/timing")