Replace simple_name with name in the Slot header in the Markdown generator#240
Conversation
|
Hi @gaurav thanks for the change, I approved But it would be good to get @hsolbrig's thoughts on this. There are some deeper questions here about slot identity that we should discuss. It looks like in your case, you are using attributes, which induce a slot name But note also that The question is, how should this be reflected in the end-user oriented markdown?
There is some discussion of this here: |
Actually, I think CCDH needs this name mangling approach: in our model, there is no reason to assume that If we did need a property to be defined identically across multiple classes, we would probably do one of two things:
|
|
I think in the CCDH case it's still fine though. You would go to the page for "id" to see the very general properties shared by all IDs. This page could also show you how id is used in all different slot_usage concepts. And the individual pages for each class would show id in the context of that class. |
|
Yup, we could do that! I still worry that this might get confusing if we have two identically named fields in two different classes, but since the class-specific definitions will be available on the class pages, it should all be clear. I'll look into that if and when it comes up. |
Check inlined or inlined_as_list slots only if range is class in schema
In the Markdown generator, the Slot page currently uses the "simple name" (i.e. the CURIE without the prefix) of the slot in the page header. When a slot is defined as part of a class (such as e.g. Specimen.derived_product), this is displayed as
Slot: specimen__derived_product, which is not very readable. In the CCDH project, we have replaced this with thenamefield of the slot, giving us the much more readable "Slot: derived_product".Alternatively, we could include the defining class in the Slot page header, possibly with a link to the entity (i.e. "Specimen.derived_product"). I'm not sure which one makes more sense given how LinkML works with slot definitions.