docs(shacl): document rules-to-SHACL-SPARQL constraint generation#23
Open
jdsika wants to merge 1 commit into
Open
docs(shacl): document rules-to-SHACL-SPARQL constraint generation#23jdsika wants to merge 1 commit into
jdsika wants to merge 1 commit into
Conversation
Signed-off-by: jdsika <carlo.van-driesten@vdl.digital>
This was referenced Jul 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the narrative documentation for the rules → SHACL-SPARQL constraint
generation to
docs/generators/shacl.rst: the--emit-rulesswitch, thethree named patterns, the compositional fallback, the skip, never
mis-translate contract, a schema → Turtle example, and the pyshacl
advanced=Truerequirement. The CLI options themselves are already coveredby the page's
.. click::directive; this section documents the behaviour.Closes the documentation gap flagged in the PR-guideline audit (new generator
features must be documented in
docs/generators/). Documentation-only —no generator code changes.
Stack position
When upstreaming, carve the relevant paragraphs into the submission that
introduces each behaviour (named patterns → framework/PIV; fallback → M1–M5).
How was this tested?
heading levels and code-block conventions.
for the example schema (verified against the test-suite fixtures).
Areas of uncertainty
may prefer a separate page as the pattern set grows.
Checklist
AI Assistance
If you used AI tools while preparing this PR, you are still the author and responsible for understanding, verifying, and defending your submission. Please engage with reviewers personally rather than through your agent during feedback and revisions. See our AI Covenant for details.