Skip to content

docs(shacl): document rules-to-SHACL-SPARQL constraint generation#23

Open
jdsika wants to merge 1 commit into
fix/shaclgen-rule-converter-audit-findingsfrom
docs/shaclgen-rule-constraints
Open

docs(shacl): document rules-to-SHACL-SPARQL constraint generation#23
jdsika wants to merge 1 commit into
fix/shaclgen-rule-converter-audit-findingsfrom
docs/shaclgen-rule-constraints

Conversation

@jdsika

@jdsika jdsika commented Jul 11, 2026

Copy link
Copy Markdown

Summary

Adds the narrative documentation for the rules → SHACL-SPARQL constraint
generation to docs/generators/shacl.rst: the --emit-rules switch, the
three named patterns, the compositional fallback, the skip, never
mis-translate
contract, a schema → Turtle example, and the pyshacl
advanced=True requirement. The CLI options themselves are already covered
by 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

main
└─ feat/shaclgen-rules-sparql                      #11 (green)
   └─ feat/shaclgen-presence-implies-value-stacked   #19
      └─ feat/shaclgen-compositional-rule-fallback   #20
         └─ fix/shaclgen-rule-converter-hardening    #21
            └─ fix/shaclgen-rule-converter-audit-findings #22
               └─ docs/shaclgen-rule-constraints    ← this PR

When upstreaming, carve the relevant paragraphs into the submission that
introduces each behaviour (named patterns → framework/PIV; fallback → M1–M5).

How was this tested?

  • Documentation-only change; the RST section follows the page's existing
    heading levels and code-block conventions.
  • The example output matches what the generator at this branch's tip emits
    for the example schema (verified against the test-suite fixtures).

Areas of uncertainty

  • Placement: the section sits under Docs before Command Line; maintainers
    may prefer a separate page as the pattern set grows.

Checklist

  • My code follows the contributor guidelines
  • I have added tests that prove my fix/feature works (n/a — docs only)
  • Existing tests pass locally with my changes

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.

Signed-off-by: jdsika <carlo.van-driesten@vdl.digital>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant