Skip to content

docs(owl): document deterministic serialization and --diff-stable - #27

Open
jdsika wants to merge 1 commit into
mainfrom
docs/rdf-deterministic-output
Open

jdsika wants to merge 1 commit into
mainfrom
docs/rdf-deterministic-output

Conversation

@jdsika

@jdsika jdsika commented Sep 11, 2026 •

Copy link
Copy Markdown

Mirror of linkml#3993, same head. Review there; this PR tracks the fork stack.

2026-10-23, second push (review): the example of a graph that is not standard RDF was the metamodel's relative IRI bibo:status <testing>, which no generator emits on current main (gen-owl, gen-rdf and gen-shacl canonicalize the metamodel without the fallback). It now names gen-shacl --include-annotations with a non-CURIE annotation tag, which does take the fallback. The section also points to the how-to for the optional dependency --diff-stable needs. Sphinx build of the docs: clean apart from four warnings that main has too (sphinx-click duplicate options, a Jupyter kernel notice).

2026-10-23: rebased onto main (a1593d16c). linkml#3985 is merged, so this is now a single documentation commit against main; no content change.

Summary

Adds a "Deterministic output" section to the gen-owl documentation:

Changes since the first version

Validation

The strict Sphinx build (-W --keep-going) passes, and the cross-reference resolves to howtos/collaborative-development.html#rdf-in-version-control.

@jdsika
jdsika force-pushed the docs/rdf-deterministic-output branch 2 times, most recently from 3bcecd5 to dc9f3ea Compare October 2, 2026 11:48
@jdsika
jdsika force-pushed the docs/rdf-deterministic-output branch from dc9f3ea to 272b8bc Compare October 13, 2026 18:58
@jdsika
jdsika changed the base branch from main to feat/diff-stable-serialization October 13, 2026 18:58
@jdsika
jdsika force-pushed the docs/rdf-deterministic-output branch from 13d8532 to 4bde563 Compare October 14, 2026 15:06
@jdsika
jdsika changed the base branch from feat/diff-stable-serialization to main October 23, 2026 09:51
@jdsika
jdsika force-pushed the docs/rdf-deterministic-output branch from 4bde563 to 1093c41 Compare October 23, 2026 09:51
Describe in the gen-owl documentation what RDFC-1.0 canonicalization
guarantees for standard RDF, why its sequential blank-node numbering can
still produce noisy diffs, and that --diff-stable reduces that churn
without guaranteeing minimal diffs. Note that the option also exists on
gen-rdf, gen-shacl and gen-shex --format rdf, and that graphs that are not
standard RDF, such as gen-shacl --include-annotations output with a
non-CURIE annotation tag, are serialized by rdflib with a warning, where
--diff-stable has no effect.

Signed-off-by: jdsika <carlo.van-driesten@vdl.digital>
@jdsika
jdsika force-pushed the docs/rdf-deterministic-output branch from 1093c41 to baa2373 Compare October 23, 2026 11:42
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