griffithlab / griffithlab/civic-docs

CIViC description field terminology inconsistent

Open
#62 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation that describes Evidence items, Assertions, and Variants, then compare its terminology with the stated data-model field names. Done means the preferred documentation change consistently identifies these fields as description rather than Statement or Summary, without changing the data model.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.