Skip to content

Commit 964da94

Browse files
committed
Added a docstring for the new signing method
1 parent b5047c0 commit 964da94

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Diff for: sigstore/sign.py

+11
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,17 @@ def sign_dsse_envelope(
233233
self,
234234
envelope: dsse.Envelope,
235235
) -> Bundle:
236+
"""
237+
Signs the provided envelope's payload, and returns a
238+
`Bundle containing the signed envelope and the verification
239+
material.
240+
241+
Args:
242+
envelope (dsse.Envelope): The envelope to be signed.
243+
244+
Returns:
245+
Bundle: The bundle containing the signed DSSE envelope.
246+
"""
236247
cert = self._signing_cert()
237248

238249
b64_cert = base64.b64encode(

0 commit comments

Comments
 (0)