search

clingen-data-model / clingen-interpretation

Allele (variant) interpretation model and API for ClinGen
3 stars 1 forks source link

internal ids do not make for readable documentation. #139

Closed bpow closed 6 years ago

bpow commented 6 years ago

Not sure of a great title for this one, but if you go to a page like this, you will see that the table that lists CAs is not as readable now that the internal identifiers for the criteria are something like 'CritAssess034' instead of 'PS1'. This also makes the search box not so useful (you used to be able to filter the table for certain ACMG criteria.

There was at one point a '_toString' column in the Type sheet that allowed for specification of how an object might be briefly represented, I'm starting to put that back in, with the idea of putting these short descriptions in the table as well.

bpow commented 6 years ago

Or maybe I should just use DomainEntity.label whenever available...

bpow commented 6 years ago

Maybe not the best solution, but it is significantly better when using DomainEntity.label

larrybabb commented 6 years ago

I don’t think our internal ids should show anywhere in our docs or examples. We should be using the @id col when supplied or manufacture a blank node I’d.

Sent from my iPhone

On Oct 9, 2017, at 3:52 PM, Bradford Powell notifications@github.com wrote:

Not sure of a great title for this one, but if you go to a page like this, you will see that the table that lists CAs is not as readable now that the internal identifiers for the criteria are something like 'CritAssess034' instead of 'PS1'. This also makes the search box not so useful (you used to be able to filter the table for certain ACMG criteria.

There was at one point a '_toString' column in the Type sheet that allowed for specification of how an object might be briefly represented, I'm starting to put that back in, with the idea of putting these short descriptions in the table as well.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.