From 4c5b7b7ef118a9ad0b620ae7c7563daa9cd1c33d Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Mon, 2 Jun 2025 14:02:38 -0500
Subject: Add note in documentation.

---
 r_qtl/r_qtl2.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'r_qtl')

diff --git a/r_qtl/r_qtl2.py b/r_qtl/r_qtl2.py
index b1eae90..06175ce 100644
--- a/r_qtl/r_qtl2.py
+++ b/r_qtl/r_qtl2.py
@@ -575,7 +575,7 @@ def read_text_file(filepath: Union[str, Path]) -> Iterator[str]:
 def read_csv_file(filepath: Union[str, Path],
                   separator: str = ",",
                   comment_char: str = "#") -> Iterator[tuple[str, ...]]:
-    """Read a file as a csv file."""
+    """Read a file as a csv file. This does not process the N/A values."""
     for line in read_text_file(filepath):
         if line.startswith(comment_char):
             continue
-- 
cgit v1.2.3