Fix documentation comment

aprilweilab · Dec 10, 2024 · e6a67c9 · e6a67c9
1 parent 1d4b77d
commit e6a67c9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/picovcf.hpp b/picovcf.hpp
@@ -1382,8 +1382,10 @@ class IGDData {
     SampleT numIndividuals() const { return m_header.numIndividuals; }
 
     /**
-     * IGD files have a fixed ploidy, so this is just getPloidy()*numIndividuals()
-     * @return Number of samples (haplotypes).
+     * IGD files have a fixed ploidy, so this is either getPloidy()*numIndividuals()
+     * (for phased data) or the same as numIndividuals() (for unphased).
+     *
+     * @return Number of samples. Every sample index will be >= 0 and < numSamples().
      */
     SampleT numSamples() const {
         if (m_header.flags & IGD_PHASED) {