Skip to content
This repository has been archived by the owner on Jan 21, 2025. It is now read-only.

Commit

Permalink
tidy up docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
nebfield committed Dec 15, 2023
1 parent 2187365 commit 60e150b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions pgscatalog_utils/scorefile/effectallele.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ def __str__(self):
return self.allele

def _is_snp(self) -> bool:
"""SNPs are the most common type of effect allele. More complex effect
alleles, like HLAs or APOE genes, often require extra work to represent in
genomes. Users should be warned about complex effect alleles.
"""SNPs are the most common type of effect allele in PGS Catalog scoring
files. More complex effect alleles, like HLAs or APOE genes, often require
extra work to represent in genomes. Users should be warned about complex
effect alleles.
>>> EffectAllele("+")._is_snp()
False
>>> EffectAllele("A")._is_snp()
Expand Down

0 comments on commit 60e150b

Please sign in to comment.