Clarify documentation on runing Earl reports #157
Conversation
| @@ -44,14 +44,23 @@ Implementation Report Process | |||
| As of early 2020, the process to generate an EARL report for the official | |||
| `JSON-LD Processor Conformance`_ page is: | |||
|
|
|||
| * Check out a local copy of the test suites:: | |||
There was a problem hiding this comment.
I think it might be better to align with the main README test section for this: https://github.com/digitalbazaar/pyld#tests. The opinionated setup there and in runtests.py is to checkout the test dirs as siblings of pyld. runtests.py defaults to looking for those dirs so you don't have to list them on command line. In the case of EARL report generation, the test dirs are explicit to avoid also running the normalization tests. As is here you'd be instructed to check out dirs in different locations than when running regular tests. Thoughts?
There was a problem hiding this comment.
Maybe this could just refer to the readme test section for setup?
CONTRIBUTING.rst
Outdated
| * Run the tests on the ``json-ld-api`` and ``json-ld-framing`` test repos to | ||
| generate a ``.jsonld`` test report: | ||
|
|
||
| * ``python tests/runtests.py ../json-ld-api/tests/ ../json-ld-framing/tests/ -e pyld-earl.jsonld`` | ||
| > ``python tests/runtests.py ..w3c/json-ld-api/tests/ ../w3c/json-ld-framing/tests/ -e pyld-earl.jsonld`` |
There was a problem hiding this comment.
As stated above, I'm not sure this w3c subdir idea is the best approach. But if so, first path is missing a /.
There was a problem hiding this comment.
I'll leave it up to you how it should be resolved -- mostly it is just that I went directly to CONTRIBUTING and there wasn't anything that prevented me from interpreting it as asking for the tests to be run against the digitalbazaar tests instead of the W3C.
Fixed typo in path
|
Closing in favor of #182 |
|
@BigBlueHat I don't think #182 addresses #156 as was the intent here. But it does change what the docs might say. I'll note it there. |
fixes issue #156