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

SEP 022 -- Rename displayId to id #54

Open
udp opened this Issue Jun 19, 2018 · 3 comments

Comments

Projects
None yet
5 participants
@udp
Member

udp commented Jun 19, 2018

@cjmyers cjmyers added this to the SBOL 3.0 milestone Jun 21, 2018

@graik

This comment has been minimized.

Contributor

graik commented Jul 3, 2018

To give a "historic" perspective, we chose this name exactly to emphasize that displayID should indeed be shown to the end user. The idea was that a good displayID was short and memorable so that I could go and tell a colleague: "We used the tetRepressor R0040 from the iGem registry." With this information alone, she could then go and fetch the exact record. I think this is a simple but very important usability feature that we should keep insisting on.

@mikebissell

This comment has been minimized.

mikebissell commented Aug 22, 2018

Just a reminder: since SBOL's reference serialization is XML, any use of 'id' as an attribute name must be considered in light of XML (and maybe XSD, relaxng) conventions, syntax, uniqueness constraints, and other rules. 'id' is special.

Also, since displayId isn't really an SBOL entity's primary unique identifier, it might not be appropriate to rename displayId to id. DisplayId is just a subsidiary identifier, basically a synonym.

See:
xsd:id
xsd:idref
https://www.w3.org/TR/xml-id/

@bbartley

This comment has been minimized.

Contributor

bbartley commented Oct 11, 2018

Hi, in the context of an SBOL-compliant URI the display ID is equivalent to a local identifier within a namespace, so I suggest changing displayId to localId

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment