From 255be07d455ba683ce424bfd7809561c4f461cde Mon Sep 17 00:00:00 2001
From: Spill-Tea <delrioj17@gmail.com>
Date: Sat, 30 May 2026 10:53:42 -0700
Subject: [PATCH] docs(oligos): update gc function docstring.

---
 src/designer_dna/oligos.py | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/designer_dna/oligos.py b/src/designer_dna/oligos.py
index 6ba7671..c9f6157 100644
--- a/src/designer_dna/oligos.py
+++ b/src/designer_dna/oligos.py
@@ -45,6 +45,7 @@
     "complement",
     "complement_py",
     "gc",
+    "gc_py",
     "manacher",
     "nrepeats",
     "nrepeats_py",
@@ -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:
@@ -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