Skip to content

Commit 2786fb3

Browse files
committed
chore: update comments
Signed-off-by: Ben Selwyn-Smith <[email protected]>
1 parent 29f3b96 commit 2786fb3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/macaron/database/db_custom_types.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright (c) 2023 - 2025, Oracle and/or its affiliates. All rights reserved.
22
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
33

4-
"""This module implements SQLAlchemy type for converting date format to RFC3339 string representation."""
4+
"""This module implements SQLAlchemy types for Python data types that cannot be automatically stored."""
55

66
import datetime
77
import json
@@ -105,14 +105,14 @@ def process_result_value(self, value: None | dict, dialect: Any) -> None | dict:
105105
class ProvenancePayload(TypeDecorator): # pylint: disable=W0223
106106
"""SQLAlchemy column type to serialize InTotoProvenance."""
107107

108-
# It is stored in the database as a json value.
108+
# It is stored in the database as a String value.
109109
impl = String
110110

111111
# To prevent Sphinx from rendering the docstrings for `cache_ok`, make this docstring private.
112112
#: :meta private:
113113
cache_ok = True
114114

115-
def process_bind_param(self, value: None | InTotoPayload, dialect: Any) -> str | None:
115+
def process_bind_param(self, value: InTotoPayload | None, dialect: Any) -> str | None:
116116
"""Process when storing an InTotoPayload object to the SQLite db.
117117
118118
value: InTotoPayload | None

src/macaron/provenance/provenance_extractor.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def extract_predicate_version(payload: InTotoPayload) -> str | None:
7373
Returns
7474
-------
7575
str | None
76-
The SLSA version, or None if .
76+
The SLSA version, or None if the payload does contain a supported version number.
7777
"""
7878
predicate_type = payload.statement.get("predicateType")
7979
if isinstance(payload, InTotoV1Payload) and predicate_type == "https://slsa.dev/provenance/v1":

0 commit comments

Comments
 (0)