Skip to content

Suggestions from January review on §1.4 #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

pchampin
Copy link
Contributor

@pchampin pchampin commented Apr 23, 2025

@pchampin pchampin added the spec:enhancement Change to enhance the spec without affecting conformance (class 2) –see also spec:editorial label Apr 23, 2025
@pchampin pchampin requested review from gkellogg, afs and hartig April 23, 2025 23:46
spec/index.html Outdated
Comment on lines 297 to 300
<p>In some serialization formats it is common
to some [=namespace IRIs=] to arbitrary [=namespace prefixes=],
and to abbreviate <a>IRIs</a> that start with one of those <a>namespace IRIs</a> by using the corresponding <a>namespace prefix</a>,
in order to assist readability.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p>In some serialization formats it is common
to some [=namespace IRIs=] to arbitrary [=namespace prefixes=],
and to abbreviate <a>IRIs</a> that start with one of those <a>namespace IRIs</a> by using the corresponding <a>namespace prefix</a>,
in order to assist readability.
<p>In some serialization formats it is common
to abbreviate <a>IRIs</a> that start with one of those <a>namespace IRIs</a> by using the corresponding <a>namespace prefix</a>,
in order to assist readability.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

a verb ("associate") was missing from my text, sorry.
Hopefully, this is now clearer.

The point was to say explicitly that the prefix-IRI association was specified in the syntax, not provided by some external convention.
(the previous wording was ambiguous in that respect)

spec/index.html Outdated
would be abbreviated as <code>rdf:XMLLiteral</code>.
Note however that these abbreviations are <em>not</em> valid IRIs,
Note however that these abbreviations are <em>not</em> valid IRIs (or only coincidentally),
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note however that these abbreviations are <em>not</em> valid IRIs (or only coincidentally),
Note, however, that these abbreviations are <em>not</em> designed to be valid IRIs,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about this... I feel that it alters the message. @afs @gkellogg @hartig WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that Ted's proposal has a slightly different touch. Users who create (/design) such abbreviations may indeed assume that they are creating valid IRIs. The purpose of the sentence is to emphasize that such an assumption is wrong.

Having said that, the "(or only coincidentally)" part that you added is also not ideal, because it is not clear what exactly that means and why that is mentioned.

How's about changing this whole part of the paragraph (including all the sentences that follow the one in question) as follows?

Note that such abbreviations are <em>not</em> meant to be processed directly as IRIs and
must not be used in syntactic contexts where IRIs are expected.
Instead, they are merely a syntactic convenience for abbreviating IRIs;
for processing, the actual IRIs are reconstructed by replacing the namespace prefixes
with the corresponding namespace IRIs.
In this sense, namespace IRIs and namespace prefixes are not a formal part of the RDF data model.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TL/DR: I like very much your proposal @hartig

FTR, the reason I added this parenthetical was that the statement is, arguably, inaccurate: rdf:type or xsd:string satisfy the IRI grammar! Whether they are valid IRIs may be a slightly different issue, if we consider that an IRI is valid only if it uses a registered scheme and complies with the additional constraints of that scheme... But I don't know of any implementation that is so strict...

Anyway, your wording is IMO much better. Can you push a commit to this branch, please?

pchampin and others added 2 commits April 25, 2025 08:17
Co-authored-by: Ted Thibodeau Jr <[email protected]>
re-reading this, I realized it could be surprising:
the predicate position of a triple is a "context where IRIs are expected",
and so this text could read as "don't use abbreviated forms in the predicate position",
which is of course not how it was intended.
Co-authored-by: Ted Thibodeau Jr <[email protected]>
Copy link
Member

@gkellogg gkellogg left a comment

Choose a reason for hiding this comment

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

I generally like this, but the bit on prefixed IRIs can use some improvement

Note however that these abbreviations are <em>not</em> valid IRIs,
and must not be used in contexts where IRIs are expected.
Note, however, that these "prefixed name" abbreviations are generally <em>not</em> valid IRIs,
and must not be used in contexts where only non-prefixed IRIs are expected.
Copy link
Contributor

Choose a reason for hiding this comment

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

such as? Is this hinting at RDF/XML and qnames?

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
and must not be used in contexts where only non-prefixed IRIs are expected.
and must not be used in contexts where only IRIs are expected.

would be abbreviated as <code>rdf:XMLLiteral</code>.
Note however that these abbreviations are <em>not</em> valid IRIs,
and must not be used in contexts where IRIs are expected.
Note, however, that these "prefixed name" abbreviations are generally <em>not</em> valid IRIs,
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefixed names are not IRIs. They could be "expanded to give IRIs during parsing".

Suggested change
Note, however, that these "prefixed name" abbreviations are generally <em>not</em> valid IRIs,
Note, however, that these "prefixed name" abbreviations are <em>not</em> valid IRIs,

I am not sure what the "valid" means here.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note, however, that these "prefixed name" abbreviations are generally <em>not</em> valid IRIs,
Note, however, that these "prefixed name" abbreviations are generally <em>not</em> IRIs,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:enhancement Change to enhance the spec without affecting conformance (class 2) –see also spec:editorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants