Skip to content

Clarify - When normative text disagrees with schema/SHACL, until resolves, text wins - #1489

Open
bact wants to merge 5 commits into
spdx:developfrom
bact:text-wins
Open

bact wants to merge 5 commits into
spdx:developfrom
bact:text-wins

Conversation

@bact

@bact bact commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Add paragraphs to say

  • We publish spec text and machine-readable artifacts (ontology/SHACL/schema). They intended to agree.
  • If normative text and artifacts disagree, it is a defect; until it resolves, the text wins.
  • Some requirements in text are not yet implemented in the artifacts, so passing validation does not automatically assumed conformance.

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact added the doc improvement Area where the project documentation needs improvement label Sep 24, 2026
@bact
bact requested review from goneall and zvr September 28, 2026 17:05

@goneall goneall left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Although I generally agree with this approach - especially making it clear to the reader what should take precedence - there have been several cases in the past where the OWL document was correct and we updated the text.

I think it would be better to state something like - "any conflicts between the artifacts and text should be treated as a defect to be resolved. Until resolution, the text will take precedence." - or something similar.

Revise per comment spdx#1489 (review)

Co-Authored-By: Gary O'Neall <gary@sourceauditor.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
bact requested a review from goneall September 29, 2026 08:11
@bact

bact commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator Author

I think it would be better to state something like - "any conflicts between the artifacts and text should be treated as a defect to be resolved. Until resolution, the text will take precedence." - or something similar.

Revised as suggested.

@bact

bact commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator Author

@henrylyons Please help review. Thank you.

@bact bact changed the title Clarify - When normative text disagree with schema/SHACL, text wins Clarify - When normative text disagrees with schema/SHACL, until resolves, text wins Sep 29, 2026
@zvr

zvr commented Sep 29, 2026

Copy link
Copy Markdown
Member

While it's useful to tell people what should prevail in the case of conflicting information, I firmly believe that this should not be placed inside the official specification text.

The specification that we publish is the text; the fact that we also produce other artifacts (ontology, schema, or even code libraries that read and write data) does not imply that these should be regarded as a higher source of truth. If there is need, as Gary writes, to update the text, we do so.

Additionally, I am reluctant to treat conflicts as "defects" that should be resolved. We know there are a number of things expressed in the text that will never be translated into the other forms. Typical example, for more than a dozen years, is the valid strings for SPDX License Expressions. Or, a more recent one, country names.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc improvement Area where the project documentation needs improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants