Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Julian committed Dec 21, 2022
1 parent 42d699f commit 38bf567
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If expected results are provided, it will compare the results produced against t
Uses
----

A key use of Bowtie is in executing as input the `official test suite <https://github.com/json-schema-org/JSON-Schema-Test-Suite>`_ and comparing the results produced by implementations to the expected ones from the suite.
A key use of Bowtie is in executing as input the `official test suite`_ and comparing the results produced by implementations to the expected ones from the suite.

Bowtie however isn't limited to just the test cases in the test suite.
It can be used to compare the validation results of any JSON Schema input across its supported implementations.
3 changes: 2 additions & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import nox

ROOT = Path(__file__).parent
PYPROJECT = ROOT / "pyproject.toml"
DOCS = ROOT / "docs"
BOWTIE = ROOT / "bowtie"
IMPLEMENTATIONS = ROOT / "implementations"
Expand Down Expand Up @@ -123,7 +124,7 @@ def docs_style(session):
"pygments",
"pygments-github-lexers",
)
session.run("python", "-m", "doc8", "--max-line-length", "1000", str(DOCS))
session.run("python", "-m", "doc8", "--config", str(PYPROJECT), str(DOCS))


@session(default=False, tags=["perf"], name="bench(smoke)")
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,9 @@ Source = "https://github.com/bowtie-json-schema/bowtie"
from_first = true
include_trailing_comma = true
multi_line_output = 3

[tool.doc8]
ignore = [
"D000", # see PyCQA/doc8#125
"D001", # one sentence per line, so max length doesn't make sense
]

0 comments on commit 38bf567

Please sign in to comment.