Skip to content

Externalise Profiling's e.g.s#945

Merged
nicholascar merged 4 commits into
gh-pagesfrom
externalise-egs
Jun 18, 2026
Merged

Externalise Profiling's e.g.s#945
nicholascar merged 4 commits into
gh-pagesfrom
externalise-egs

Conversation

@nicholascar

Copy link
Copy Markdown
Contributor

Move all the example Turtle in Profiling to external files to allow content syntax validation.

Closes #926

@nicholascar nicholascar added the Profiles For SHACL 1.2 Profiles spec label Jun 18, 2026
Comment thread shacl12-profiling/examples/README.md Outdated
Co-authored-by: Alex Nelson <alexander.nelson@nist.gov>
@ajnelson-nist

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, apologies, my approval comment went in between you posting this remark and it displaying for me.

I concur.

@ajnelson-nist ajnelson-nist left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@nicholascar nicholascar merged commit a428573 into gh-pages Jun 18, 2026
2 checks passed
@nicholascar nicholascar deleted the externalise-egs branch June 18, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Profiles For SHACL 1.2 Profiles spec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Externalise RDF examples for validation

2 participants