Externalise Profiling's e.g.s#945
Conversation
Co-authored-by: Alex Nelson <alexander.nelson@nist.gov>
|
I'd thought we would have self-sufficient Turtle files, rather than files requiring some reconstruction and reformatting to be ingestible RDF. I appreciate that inlining the prefixes in each example would probably make the document pretty busy-looking. Should the example boxes in the displayed document work when someone copy-pastes the whole box into a new file? I've had some trouble when learning other languages that have code snippets in HTML documentation focus on the highlights of a coding moment, rather than provide a fully compilable program that just uses comments or something to say "And here's the important part for this documentation page." All that said, I am happy we have a syntax check now. |
| @@ -0,0 +1,13 @@ | |||
| import sys | |||
| from rdflib import Graph | |||
There was a problem hiding this comment.
Confirming - it's OK to have this dependency? I know we're not running this in CI at the moment.
Hm. Should we run this in CI?
There was a problem hiding this comment.
We might only use this example checking for our doc development and not when the doc is published, so I think it's overkill to automate
There was a problem hiding this comment.
Ah, apologies, my approval comment went in between you posting this remark and it displaying for me.
I concur.
ajnelson-nist
left a comment
There was a problem hiding this comment.
This is good-enough to merge to me. I see one remaining opportunity to add CI, but that probably doesn't need to happen immediately.
Move all the example Turtle in Profiling to external files to allow content syntax validation.
Closes #926