From a2426a678d47c4dd7ecb891bf82c57b4201af702 Mon Sep 17 00:00:00 2001
From: Kamal Marhubi <kamal@marhubi.com>
Date: Fri, 15 Apr 2016 01:11:04 -0400
Subject: [PATCH] config: Rename get_variant_names to doc_hint

The `ConfigType` trait is implemented for non-enum types, so the name no
longer makes perfect sense.
---
 src/config.rs | 17 +++++++++--------
 src/utils.rs  |  2 +-
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/src/config.rs b/src/config.rs
index 0fecdd49a087..3316984b8619 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -153,26 +153,27 @@ configuration_option_enum! { WriteMode:
     Checkstyle,
 }
 
-// This trait and the following impl blocks are there so that we an use
-// UCFS inside the get_docs() function on types for configs.
-pub trait ConfigType {
-    fn get_variant_names() -> String;
+/// Trait for types that can be used in `Config`.
+pub trait ConfigType: Sized {
+    /// Returns hint text for use in `Config::print_docs()`. For enum types, this is a
+    /// pipe-separated list of variants; for other types it returns "<type>".
+    fn doc_hint() -> String;
 }
 
 impl ConfigType for bool {
-    fn get_variant_names() -> String {
+    fn doc_hint() -> String {
         String::from("<boolean>")
     }
 }
 
 impl ConfigType for usize {
-    fn get_variant_names() -> String {
+    fn doc_hint() -> String {
         String::from("<unsigned integer>")
     }
 }
 
 impl ConfigType for String {
-    fn get_variant_names() -> String {
+    fn doc_hint() -> String {
         String::from("<string>")
     }
 }
@@ -278,7 +279,7 @@ macro_rules! create_config {
                     name_out.push(' ');
                     println!("{}{} Default: {:?}",
                              name_out,
-                             <$ty>::get_variant_names(),
+                             <$ty>::doc_hint(),
                              $def);
                     $(
                         println!("{}{}", space_str, $dstring);
diff --git a/src/utils.rs b/src/utils.rs
index a3c7c036879d..f9debdbcec35 100644
--- a/src/utils.rs
+++ b/src/utils.rs
@@ -219,7 +219,7 @@ macro_rules! impl_enum_decodable {
         }
 
         impl ::config::ConfigType for $e {
-            fn get_variant_names() -> String {
+            fn doc_hint() -> String {
                 let mut variants = Vec::new();
                 $(
                     variants.push(stringify!($x));