sct, oidc: doc diagnostics methods

Signed-off-by: Andrew Pan <a@tny.town>
sigstore · Mar 9, 2023 · 2f6ffb7 · 2f6ffb7
1 parent d1b86c9
commit 2f6ffb7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/sigstore/_internal/sct.py b/sigstore/_internal/sct.py
@@ -141,6 +141,7 @@ class InvalidSCTError(Error):
     """
 
     def diagnostics(self) -> str:
+        """Returns diagnostics for the error."""
         # We specialize this error case, since it usually indicates one of
         # two conditions: either the current sigstore client is out-of-date,
         # or that the SCT is well-formed but invalid for the current configuration

diff --git a/sigstore/oidc.py b/sigstore/oidc.py
@@ -197,6 +197,7 @@ class GitHubOidcPermissionCredentialError(AmbientCredentialError):
     """
 
     def diagnostics(self) -> str:
+        """Returns diagnostics for the error."""
         return f"""
             Insufficient permissions for GitHub Actions workflow.