You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The field for capturing human-readable text about an evidence item is stored in the description field in our data model, but is formally described as Statement in docs. This discrepancy can cause confusion to downstream consumers of CIViC content, and I recommend we either change our documentation (preferred) or our data model to align the term used to describe this.
The analogous field in Assertions is description (data model and documentation), and the analogous field in Variants is similarly confusing, called description in our data model and Summary in our documentation.
The text was updated successfully, but these errors were encountered:
ahwagner
added a commit
to griffithlab/civicpy
that referenced
this issue
May 13, 2020
The field for capturing human-readable text about an evidence item is stored in the
description
field in our data model, but is formally described asStatement
in docs. This discrepancy can cause confusion to downstream consumers of CIViC content, and I recommend we either change our documentation (preferred) or our data model to align the term used to describe this.The analogous field in Assertions is
description
(data model and documentation), and the analogous field in Variants is similarly confusing, calleddescription
in our data model andSummary
in our documentation.The text was updated successfully, but these errors were encountered: