Skip to content

Commit ecd924c

Browse files
committed
Update docstrings
1 parent f06467f commit ecd924c

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

src/hermes_plugin_software_card/curate.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,24 @@ def __call__(
8989
def prepare(self, metadata: SoftwareMetadata):
9090
"""Prepare the validation.
9191
92-
The metadata given in the context is parsed as an RDF graph and then validated
93-
using the Software CaRD validation.
92+
The metadata given in ``metadata`` is parsed as an RDF graph for validation.
9493
"""
9594
self._data_graph = read_rdf_resource(
9695
format="json-ld", data=json.dumps(metadata.ld_value)
9796
)
9897
self._shacl_graph = make_shacl_graph(Config.from_dict(self._validation_config))
9998

10099
def validate(self):
101-
"""Run Software CaRD validation."""
100+
"""Run Software CaRD validation on the given software metadata."""
102101
conforms, validation_graph = validate_graph(self._data_graph, self._shacl_graph)
103102
self._conforms = conforms
104103
self._validation_graph = validation_graph
105104

106105
def create_report(self):
107106
"""Create validation report.
108107
109-
This creates the report both as a machine-readble JSON-LD file, and prints the
110-
URL to the Software CaRD web app to the screen.
108+
This creates the report both as a machine-readble JSON-LD file, and prints a
109+
human-readable report, and the URL to the Software CaRD web app to the screen.
111110
"""
112111
ctx = HermesCacheManager()
113112
validation_file = ctx.cache_dir / "curate" / "validation.json"

0 commit comments

Comments
 (0)