Minor fixes

scripts/gen_format_schemas.py

@@ -1,6 +1,16 @@
 #!/usr/bin/env python3
 # Copyright Kani Contributors
 # SPDX-License-Identifier: Apache-2.0 OR MIT
+#
+# Generate documentation for every public class in the `benchcomp.schemas`
+# module. This script generates one Markdown file for each class; these Markdown
+# files can then be included in the Kani book.
+#
+# The script first dumps the schema into JSON Draft-07 [1] format, and then used
+# the json_schema_for_humans package to render that into Markdown.
+#
+# [1] https://json-schema.org/draft-07/json-schema-release-notes.html
+
 
 import inspect
 import json
@@ -45,8 +55,6 @@ def main():
 
  with open(tmpdir / f"{name}.json", "w") as handle:
  print(json.dumps(schema_docs, indent=2), file=handle)
- with open(f"/tmp/{name}.json", "w") as handle:
- print(json.dumps(schema_docs, indent=2), file=handle)
 
  jsfh.generate.generate_from_filename(
  tmpdir, out_dir / f"{name}.md", config=config)

tools/benchcomp/benchcomp/__init__.py

@@ -20,7 +20,7 @@ class _SchemaValidator:
  """Validate data structures with a schema
 
  Objects of this class are callable, with a single `data` argument. The data
- is validated and returned if the `schema` packages is installed, or returned
+ is validated and returned if the `schema` package is installed, or returned
  if not.
  """
 

tools/benchcomp/benchcomp/schemas.py

@@ -46,9 +46,8 @@ def _replace_types(self, schema_dict):
 
  def __call__(self):
  s = self.get_raw_schema()
- name, description = s["name"], s["description"]
  ret = self._replace_types(s["schema"])
- return schema.Schema(ret, name=name, description=description)
+ return schema.Schema(ret, name=s["name"], description=s["description]")
 
 
 

tools/benchcomp/requirements.txt

@@ -1,3 +1,3 @@
-schema
 json-schema-for-humans
 pyyaml
+schema