Skip to content
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

clarify inputBytes, inputDocument, inputMediaType #1438

Merged
merged 1 commit into from
Feb 27, 2024
Merged

clarify inputBytes, inputDocument, inputMediaType #1438

merged 1 commit into from
Feb 27, 2024

Conversation

TallTed
Copy link
Member

@TallTed TallTed commented Feb 14, 2024

fixes #1402


Preview | Diff

Copy link
Member

@iherman iherman left a comment

Choose a reason for hiding this comment

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

A very practical issue aiming to avoid future merge conflicts...

Following the WG agreement, I have created a PR (#1440) changing the property mediaType to encodingFormat. I was wondering whether it wouldn't be better, for the sake of consistency, to use the term inputEncodingFormat instead of inputMediaType in this algorithm. It may be wiser if we agreed on this issue in this PR and, possibly, the term was changed here (and my PR concentrates exclusively on the property).

Note that the term mediaType also appears in the body of the algorithm. That should either be changed or kept unchanged, in sync with the change of the argument name.

Personally, I am in favour of changing the algorithm argument name, but I won't lie down the road if the agreement is to leave it as is.

@TallTed
Copy link
Member Author

TallTed commented Feb 15, 2024

Consistency is generally better than not.

That said, I don't like the change to encodingFormat because I don't think it's an accurate label nor particularly well defined by schema.org.

I also note (too late for that decision, but perhaps it might be reconsidered) https://www.w3.org/ns/iana/media-types/ which seems like it should be taken into account for W3 purposes.

@iherman
Copy link
Member

iherman commented Feb 16, 2024

Consistency is generally better than not.

That said, I don't like the change to encodingFormat because I don't think it's an accurate label nor particularly well defined by schema.org.

I have to agree with you on this. As I said, I can live with inconsistency; we just to agree that we all accept it.

I also note (too late for that decision, but perhaps it might be reconsidered) https://www.w3.org/ns/iana/media-types/ which seems like it should be taken into account for W3 purposes.

This is a very strange namespace (never saw this before). It seems to assign, for each specific media type, a class. If we used this, Example 28 would look like:

  "image": {
     "id": "https:....",
     "digestSRI" : "sha384-......",
     "type" : "https://www.w3.org/ns/iana/media-types/image/svg+xml#Resource"

this can work, but I am afraid it would be a bit unnatural to use...

@msporny @dlongley ?

@TallTed
Copy link
Member Author

TallTed commented Feb 21, 2024

s/"https://www.w3.org/ns/iana/media-types/application/svg+xml#Resource"/"https://www.w3.org/ns/iana/media-types/image/svg+xml#Resource"/, I think?

(And, of course, the document at the latter link includes mention of application/svg+xml which is not listed in the main table on https://www.w3.org/ns/iana/media-types/. sighs)

@iherman
Copy link
Member

iherman commented Feb 21, 2024

s/"https://www.w3.org/ns/iana/media-types/application/svg+xml#Resource"/"https://www.w3.org/ns/iana/media-types/image/svg+xml#Resource"/, I think?

Yep, sorry. I will edit the comment just to make it o.k.

(And, of course, the document at the latter link includes mention of application/svg+xml which is not listed in the main table on https://www.w3.org/ns/iana/media-types/. sighs)

@decentralgabe
Copy link
Contributor

@iherman this one ready too?

@iherman
Copy link
Member

iherman commented Feb 27, 2024

@decentralgabe yes. The issue of mediaType remaining is still pending, the other PR has been closed, so it should not affect this PR. Merge ahead...

@decentralgabe
Copy link
Contributor

editorial approval, open >1 week, changes addressed. merging!

@decentralgabe decentralgabe merged commit 0099a3a into w3c:main Feb 27, 2024
1 check passed
@TallTed TallTed deleted the patch-2 branch February 27, 2024 18:10
@msporny msporny added editorial Purely editorial changes to the specification. CR1 This item was processed during CR1 labels Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

phrasing and/or punctuation for input "inputBytes or inputDocument and inputMediaType" needs work
4 participants