chore: bring commit signatures up to date with 12.10

nejch · nejch · commit 4279aee6c2ad · 2020-04-22T23:01:55.000+02:00
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -258,7 +258,7 @@ Get a specific project commit by its SHA id:
 
    $ gitlab project-commit get --project-id 2 --id a43290c
 
-Get the GPG signature of a signed commit:
+Get the signature (e.g. GPG or x509) of a signed commit:
 
 .. code-block:: console
 
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst
@@ -82,7 +82,7 @@ Get the references the commit has been pushed to (branches and tags)::
     commit.refs('tag')  # only tags
     commit.refs('branch')  # only branches
 
-Get the GPG signature of the commit (if the commit was signed)::
+Get the signature of the commit (if the commit was signed, e.g. with GPG or x509)::
 
     commit.signature()
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -2299,7 +2299,7 @@ def revert(self, branch, **kwargs):
     @cli.register_custom_action("ProjectCommit")
     @exc.on_http_error(exc.GitlabGetError)
     def signature(self, **kwargs):
-        """Get the GPG signature of the commit.
+        """Get the signature of the commit.
 
         Args:
             **kwargs: Extra options to send to the server (e.g. sudo)
@@ -2309,7 +2309,7 @@ def signature(self, **kwargs):
             GitlabGetError: If the signature could not be retrieved
 
         Returns:
-            dict: The commit's GPG signature data
+            dict: The commit's signature data
         """
         path = "%s/%s/signature" % (self.manager.path, self.get_id())
         return self.manager.gitlab.http_get(path, **kwargs)
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -500,13 +500,13 @@
 # assert commit.refs()
 # assert commit.merge_requests()
 
-# commit GPG signature (for unsigned commits)
+# commit signature (for unsigned commits)
 # TODO: reasonable tests for signed commits?
 try:
     signature = commit.signature()
 except gitlab.GitlabGetError as e:
     error_message = e.error_message
-assert error_message == "404 GPG Signature Not Found"
+assert error_message == "404 Signature Not Found"
 
 # commit comment
 commit.comments.create({"note": "This is a commit comment"})
