From 0cea706f10aa41e7689b9d34bac66fd446648515 Mon Sep 17 00:00:00 2001
From: Jason Wolfe <mypetclone@gmail.com>
Date: Fri, 18 May 2018 13:53:29 +0900
Subject: [PATCH] Add docs to new Query methods (#307)

---
 src/query/boolean_query/boolean_query.rs | 1 +
 src/query/phrase_query/phrase_query.rs   | 2 ++
 src/query/term_query/term_query.rs       | 1 +
 3 files changed, 4 insertions(+)

diff --git a/src/query/boolean_query/boolean_query.rs b/src/query/boolean_query/boolean_query.rs
index f4fa84c08..286d9f449 100644
--- a/src/query/boolean_query/boolean_query.rs
+++ b/src/query/boolean_query/boolean_query.rs
@@ -66,6 +66,7 @@ impl BooleanQuery {
         BooleanQuery::from(occur_term_queries)
     }
 
+    /// Deconstructed view of the clauses making up this query.
     pub fn clauses(&self) -> &[(Occur, Box<Query>)] {
         &self.subqueries[..]
     }
diff --git a/src/query/phrase_query/phrase_query.rs b/src/query/phrase_query/phrase_query.rs
index 0834442d1..0bb74b912 100644
--- a/src/query/phrase_query/phrase_query.rs
+++ b/src/query/phrase_query/phrase_query.rs
@@ -48,10 +48,12 @@ impl PhraseQuery {
         }
     }
 
+    /// The `Field` this `PhraseQuery` is targeting.
     pub fn field(&self) -> Field {
         self.field
     }
 
+    /// The `Term`s in the phrase making up this `PhraseQuery`.
     pub fn phrase_terms(&self) -> &[Term] {
         &self.phrase_terms[..]
     }
diff --git a/src/query/term_query/term_query.rs b/src/query/term_query/term_query.rs
index 82308b7d6..dae8e8c74 100644
--- a/src/query/term_query/term_query.rs
+++ b/src/query/term_query/term_query.rs
@@ -31,6 +31,7 @@ impl TermQuery {
         }
     }
 
+    /// The `Term` this query is built out of.
     pub fn term(&self) -> &Term {
         &self.term
     }