more doc strings

Author: mr-c

cwlprov/prov.py

@@ -383,6 +383,7 @@ def derivations(self) -> Iterable["Derivation"]:
         return self._records(ProvDerivation, Derivation, PROV_ATTR_USED_ENTITY)
 
     def secondary_files(self) -> list[Any]:
+        """Return any SecondaryFiles for this Entity."""
         return [
             d.generated_entity()
             for d in self.derivations()

cwlprov/ro.py

@@ -183,17 +183,20 @@ def _uriref(
 
     @property
     def conformsTo(self) -> set[str]:
+        """Find which things this RO conforms to."""
         resource = self._uriref()
         return set(map(str, self.manifest.objects(resource, DCTERMS.conformsTo)))
 
     @property
     def createdBy(self) -> set["Agent"]:
+        """Find the set of Agents who created this RO."""
         resource = self._uriref()
         new_agent = partial(Agent, self.manifest)
         return set(map(new_agent, self.manifest.objects(resource, PAV.createdBy)))
 
     @property
     def authoredBy(self) -> set["Agent"]:
+        """Find the set of Agents who authored this RO."""
         resource = self._uriref()
         new_agent = partial(Agent, self.manifest)
         return set(map(new_agent, self.manifest.objects(resource, PAV.authoredBy)))

cwlprov/tool.py

@@ -130,6 +130,7 @@ class Status(IntEnum):
 
 
 def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
+    """Parse the command line arguments."""
     parser = argparse.ArgumentParser(
         description="cwlprov explores Research Objects containing provenance of "
         "Common Workflow Language executions. <https://w3id.org/cwl/prov/>"
@@ -485,8 +486,10 @@ def _set_log_level(quiet: Optional[bool] = None, verbose: int = 0) -> None:
 
 
 class Tool(ContextManager["Tool"]):
+    """The cwlprov-py tool."""
+
     def __init__(self, args: Optional[list[str]] = None) -> None:
-        """Create a Tool and open the output stream."""
+        """Open the output stream."""
         self.args = parse_args(args)
         if self.args.output != "-":
             self.output: Optional[TextIO] = open(
@@ -1505,6 +1508,7 @@ def run(self) -> int:
 
 
 def main(args: Optional[list[str]] = None) -> int:
+    """Run the cwlprov-py tool."""
     with Tool(args) as tool:
         try:
             return tool.main()