From 3835a6ca001ad18d7980a58c705de65356a70dbb Mon Sep 17 00:00:00 2001 From: Jirka Date: Tue, 18 Jul 2023 23:03:17 +0200 Subject: [PATCH] precommit/docformatter --- .pre-commit-config.yaml | 14 +++++++------- github/CheckRun.py | 5 +++-- github/CheckSuite.py | 6 ++++-- github/CodeScanAlert.py | 5 +++-- github/CodeScanAlertInstance.py | 5 +++-- github/CodeScanAlertInstanceLocation.py | 5 +++-- github/CodeScanRule.py | 5 +++-- github/CodeScanTool.py | 5 +++-- github/Commit.py | 6 ++++-- github/CommitCombinedStatus.py | 6 ++++-- github/Comparison.py | 4 +--- github/Path.py | 5 +++-- 12 files changed, 41 insertions(+), 30 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7698bf4ea8..c6723d2e5f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,6 +12,13 @@ repos: hooks: - id: black + - repo: https://github.com/PyCQA/docformatter + rev: v1.7.3 + hooks: + - id: docformatter + additional_dependencies: [tomli] + args: ["--in-place"] + - repo: https://github.com/asottile/seed-isort-config rev: v2.2.0 hooks: @@ -37,13 +44,6 @@ repos: - id: pyupgrade args: ["--py37-plus"] - - repo: https://github.com/PyCQA/docformatter - rev: v1.7.3 - hooks: - - id: docformatter - additional_dependencies: [tomli] - args: ["--in-place"] - - repo: https://github.com/pycqa/flake8 rev: 3.9.2 hooks: diff --git a/github/CheckRun.py b/github/CheckRun.py index 61eaf9981b..3e26bdd5ba 100644 --- a/github/CheckRun.py +++ b/github/CheckRun.py @@ -49,9 +49,10 @@ class CheckRun(CompletableGithubObject): - """ - This class represents check runs. + """This class represents check runs. + The reference can be found here https://docs.github.com/en/rest/reference/checks#check-runs + """ def _initAttributes(self) -> None: diff --git a/github/CheckSuite.py b/github/CheckSuite.py index a6d2eec847..6ee5ba34b3 100644 --- a/github/CheckSuite.py +++ b/github/CheckSuite.py @@ -42,8 +42,10 @@ class CheckSuite(CompletableGithubObject): - """ - This class represents check suites. The reference can be found here https://docs.github.com/en/rest/reference/checks#check-suites + """This class represents check suites. + + The reference can be found here https://docs.github.com/en/rest/reference/checks#check-suites + """ def _initAttributes(self) -> None: diff --git a/github/CodeScanAlert.py b/github/CodeScanAlert.py index f31c77e8e6..ec97291f89 100644 --- a/github/CodeScanAlert.py +++ b/github/CodeScanAlert.py @@ -34,9 +34,10 @@ class CodeScanAlert(NonCompletableGithubObject): - """ - This class represents alerts from code scanning. + """This class represents alerts from code scanning. + The reference can be found here https://docs.github.com/en/rest/reference/code-scanning. + """ def _initAttributes(self) -> None: diff --git a/github/CodeScanAlertInstance.py b/github/CodeScanAlertInstance.py index 75ee0f54a7..13bf09fec2 100644 --- a/github/CodeScanAlertInstance.py +++ b/github/CodeScanAlertInstance.py @@ -31,9 +31,10 @@ class CodeScanAlertInstance(NonCompletableGithubObject): - """ - This class represents code scanning alert instances. + """This class represents code scanning alert instances. + The reference can be found here https://docs.github.com/en/rest/reference/code-scanning. + """ def _initAttributes(self) -> None: diff --git a/github/CodeScanAlertInstanceLocation.py b/github/CodeScanAlertInstanceLocation.py index fad746651f..898f326d0a 100644 --- a/github/CodeScanAlertInstanceLocation.py +++ b/github/CodeScanAlertInstanceLocation.py @@ -25,9 +25,10 @@ class CodeScanAlertInstanceLocation(NonCompletableGithubObject): - """ - This class represents code scanning alert instance locations. + """This class represents code scanning alert instance locations. + The reference can be found here https://docs.github.com/en/rest/reference/code-scanning. + """ def _initAttributes(self) -> None: diff --git a/github/CodeScanRule.py b/github/CodeScanRule.py index 98eb0f7687..e561f2cbff 100644 --- a/github/CodeScanRule.py +++ b/github/CodeScanRule.py @@ -27,9 +27,10 @@ class CodeScanRule(NonCompletableGithubObject): - """ - This class represents Alerts from code scanning. + """This class represents Alerts from code scanning. + The reference can be found here https://docs.github.com/en/rest/reference/code-scanning. + """ def _initAttributes(self) -> None: diff --git a/github/CodeScanTool.py b/github/CodeScanTool.py index d944c8cbd3..83259d737d 100644 --- a/github/CodeScanTool.py +++ b/github/CodeScanTool.py @@ -26,9 +26,10 @@ class CodeScanTool(NonCompletableGithubObject): - """ - This class represents code scanning tools. + """This class represents code scanning tools. + The reference can be found here https://docs.github.com/en/rest/reference/code-scanning. + """ def _initAttributes(self) -> None: diff --git a/github/Commit.py b/github/Commit.py index 4f944e8bb5..8936032886 100644 --- a/github/Commit.py +++ b/github/Commit.py @@ -60,8 +60,10 @@ class Commit(CompletableGithubObject): - """ - This class represents Commits. The reference can be found here https://docs.github.com/en/rest/reference/git#commits + """This class represents Commits. + + The reference can be found here https://docs.github.com/en/rest/reference/git#commits + """ def _initAttributes(self) -> None: diff --git a/github/CommitCombinedStatus.py b/github/CommitCombinedStatus.py index d9bfdb3074..3142d311f5 100644 --- a/github/CommitCombinedStatus.py +++ b/github/CommitCombinedStatus.py @@ -33,8 +33,10 @@ class CommitCombinedStatus(NonCompletableGithubObject): - """ - This class represents CommitCombinedStatuses. The reference can be found here https://docs.github.com/en/rest/reference/repos#statuses + """This class represents CommitCombinedStatuses. + + The reference can be found here https://docs.github.com/en/rest/reference/repos#statuses + """ def _initAttributes(self) -> None: diff --git a/github/Comparison.py b/github/Comparison.py index f09e3ef2b9..e6ea82fb52 100644 --- a/github/Comparison.py +++ b/github/Comparison.py @@ -36,9 +36,7 @@ class Comparison(CompletableGithubObject): - """ - This class represents Comparisons - """ + """This class represents Comparisons.""" def _initAttributes(self) -> None: self._ahead_by: Attribute[int] = NotSet diff --git a/github/Path.py b/github/Path.py index f966392f55..b8c6335d98 100644 --- a/github/Path.py +++ b/github/Path.py @@ -29,9 +29,10 @@ class Path(NonCompletableGithubObject): - """ - This class represents a popular Path for a GitHub repository. + """This class represents a popular Path for a GitHub repository. + The reference can be found here https://docs.github.com/en/rest/reference/repos#traffic + """ def _initAttributes(self) -> None: