add docstrings

BiocPy · Jan 22, 2024 · 4dea976 · 4dea976
1 parent a99676e
commit 4dea976
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/src/rds2py/granges.py b/src/rds2py/granges.py
@@ -11,6 +11,17 @@
 
 
 def as_granges(robj):
+    """Parse an R object as a :py:class:`~genomicranges.GenomicRanges.GenomicRanges`.
+
+    Args:
+        robj:
+            Object parsed from the `RDS` file.
+
+            Usually the result of :py:func:`~rds2py.parser.read_rds`.
+
+    Returns:
+        A ``GenomicRanges`` object.
+    """
     _cls = get_class(robj)
 
     if _cls not in ["GenomicRanges", "GRanges"]:
@@ -65,6 +76,17 @@ def as_granges(robj):
 
 
 def _as_list(robj):
+    """Parse an R object as a :py:class:`~list`.
+
+    Args:
+        robj:
+            Object parsed from the `RDS` file.
+
+            Usually the result of :py:func:`~rds2py.parser.read_rds`.
+
+    Returns:
+        A ``list`` of the Rle class.
+    """
     _cls = get_class(robj)
 
     if _cls not in ["Rle"]: