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

CIViC description field terminology inconsistent #62

Open
ahwagner opened this issue May 13, 2020 · 1 comment
Open

CIViC description field terminology inconsistent #62

ahwagner opened this issue May 13, 2020 · 1 comment

Comments

@ahwagner
Copy link
Member

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.

ahwagner added a commit to griffithlab/civicpy that referenced this issue May 13, 2020
@ahwagner
Copy link
Member Author

From discussion with @susannasiebert and @acoffman it sounds like the effort of resolving this in the data model is probably best reserved for v2.

The documentation is also aligned with what is presented in the web client.

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

No branches or pull requests

1 participant