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

Comments #3

Open
HLWeil opened this issue Mar 15, 2024 · 2 comments
Open

Comments #3

HLWeil opened this issue Mar 15, 2024 · 2 comments
Assignees

Comments

@HLWeil
Copy link
Member

HLWeil commented Mar 15, 2024

Currently, the whole specification of how to handle Comments is a bit messy. In ISA, a lot of types have a property called Comments of type ISA Comment array.
Unfortunately, not all of their equivalent types in Schema.org contain a property comment of range https://schema.org/Comment. So for some cases like https://schema.org/Person, we use disambiguatingDescription of range Text. But this is not ideal, as now the encoders for the same type in ISA needs to produce different objects in JsonLD.
Additionally, currently the Investigation profile defines disambiguatingDescription, even though this is inconsistent with the other CreativeWork objects.

Not sure how to handle this. Just wanted to write it down before it gets forgotten.

@floWetzels
Copy link
Collaborator

Currently, the whole specification of how to handle Comments is a bit messy. In ISA, a lot of types have a property called Comments of type ISA Comment array. Unfortunately, not all of their equivalent types in Schema.org contain a property comment of range https://schema.org/Comment. So for some cases like https://schema.org/Person, we use disambiguatingDescription of range Text.

I agree, it is not nice at the moment. But I think there is no better way around this Problem.

But this is not ideal, as now the encoders for the same type in ISA needs to produce different objects in JsonLD.

This is just a technical problem, right? I don't think this is the right place to discuss it, but from my point of view, it's not a big hurdle. We just define two different encoders for the ISA type Comment, so there should be no problem with them producing different json objects.

Additionally, currently the Investigation profile defines disambiguatingDescription, even though this is inconsistent with the other CreativeWork objects.

That is indeed a bug, as far as I can tell. Same holds for ScholarlyArticle. @stuzart, do you know if this is by design or just a bug?

@HLWeil HLWeil removed the Status: Needs Triage This item is up for investigation. label Jun 27, 2024
@HLWeil HLWeil moved this to In progress in ARCStack Jun 27, 2024
@floWetzels
Copy link
Collaborator

The actual bug regarding Investigation and ScholarlyArticle has been fixed.
@HLWeil and I agreed on specificying the usage of disambiguatingDescription more precisely in the profile where it needs to be used for comments. I will take care of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

3 participants