Skip to content

docs(oligos): update gc function docstring. #18

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.

Sign up for GitHub

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

Merged
Spill-Tea merged 1 commit into from
May 30, 2026
Merged

docs(oligos): update gc function docstring. #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/designer_dna/oligos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"complement",
"complement_py",
"gc",
"gc_py",
"manacher",
"nrepeats",
"nrepeats_py",
Expand Down Expand Up @@ -268,7 +269,7 @@ def nrepeats_py(sequence: str, n: int) -> int:
"""Calculate the longest substring of n repeating characters.

Args:
sequence (str): Nucleotide string or Series of string
sequence (str): Nucleotide sequence string.
n (int): stretch of k-mer to observe

Returns:
Expand Down Expand Up @@ -305,7 +306,15 @@ def nrepeats_py(sequence: str, n: int) -> int:


def gc_py(sequence: str) -> float:
"""Calculate gc content of a nucleotide sequence."""
"""Calculate gc content of a nucleotide sequence.

Args:
sequence (str): Nucleotide sequence string.

Returns:
(float) gc fraction content of sequence.

"""
length: float = float(len(sequence))

return length and (sequence.count("G") + sequence.count("C")) / length
Loading