From 24c094473cc1a67aad97ba1f84063db95901270c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20K=C3=B6ster?= <johannes.koester@tu-dortmund.de>
Date: Tue, 6 Jul 2021 11:01:42 +0200
Subject: [PATCH] docs: some minor documentation improvements

---
 src/bcf/record.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/bcf/record.rs b/src/bcf/record.rs
index 12c43bc3f..1e748d610 100644
--- a/src/bcf/record.rs
+++ b/src/bcf/record.rs
@@ -626,7 +626,7 @@ impl Record {
         }
     }
 
-    /// Get the number of samples.
+    /// Get the number of samples in the record.
     pub fn sample_count(&self) -> u32 {
         self.inner().n_sample()
     }
@@ -675,6 +675,7 @@ impl Record {
     }
 
     /// Get genotypes as vector of one `Genotype` per sample.
+    /// 
     /// # Example
     /// Parsing genotype field (`GT` tag) from a VCF record:
     /// ```
@@ -691,6 +692,8 @@ impl Record {
         self.genotypes_shared_buffer(Buffer::new())
     }
 
+    /// Get genotypes as vector of one `Genotype` per sample, using a given shared buffer 
+    /// to avoid unnecessary allocations.
     pub fn genotypes_shared_buffer<'a, B>(&self, buffer: B) -> Result<Genotypes<'a, B>>
     where
         B: BorrowMut<Buffer> + Borrow<Buffer> + 'a,