vcf/variant/record_buf/filters: Add examples

zaeleus · Apr 1, 2024 · 89e34cd · 89e34cd
1 parent b2db59f
commit 89e34cd
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/noodles-vcf/src/variant/record_buf/filters.rs b/noodles-vcf/src/variant/record_buf/filters.rs
@@ -12,11 +12,31 @@ pub struct Filters(IndexSet<String>);
 
 impl Filters {
     /// Creates a PASS filter.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use noodles_vcf::variant::record_buf::Filters;
+    /// let filters = Filters::pass();
+    /// assert!(filters.is_pass());
+    /// ```
     pub fn pass() -> Self {
         [String::from(PASS)].into_iter().collect()
     }
 
     /// Returns whether this is a PASS filter.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use noodles_vcf::variant::record_buf::Filters;
+    ///
+    /// let filters = Filters::pass();
+    /// assert!(filters.is_pass());
+    ///
+    /// let filters: Filters = [String::from("q10")].into_iter().collect();
+    /// assert!(!filters.is_pass());
+    /// ```
     pub fn is_pass(&self) -> bool {
         self.0
             .first()