Add stringify_segment rustdoc

1 files changed, 21 insertions, 3 deletions

diff --git a/src/print.rs b/src/print.rs
index b4ce7ab75..2aad9019b 100644
--- a/src/print.rs
+++ b/src/print.rs
@@ -5,26 +5,44 @@ use clap::ArgMatches;
 pub fn prompt(args: ArgMatches) {
     let default_prompt = vec!["directory", "line_break", "character"];
 
-    default_prompt.into_iter()
+    default_prompt
+        .into_iter()
         .map(|module| modules::handle(module, &args))
         .map(|segment| stringify_segment(segment))
         .for_each(|segment_string| print!("{}", segment_string));
 }
 
+/// Create a string with the formatted contents of a segment
+///
+/// Will recursively also format the prefix and suffix of the segment being
+/// stringified.
+///
+/// # Example
+/// ```
+/// use starship::modules::Segment;
+///
+/// let segment = Segment {
+///     value: String::from("->"),
+///     ..Default::default()
+/// };
+///
+/// let result = starship::print::stringify_segment(segment);
+/// assert_eq!(result, "-> ");
+/// ```
 pub fn stringify_segment(segment: Segment) -> String {
     let Segment {
         prefix,
         value,
         style,
         suffix,
-    } = segment;    
+    } = segment;
 
     let mut segment_string = String::new();
 
     if let Some(prefix) = prefix {
         segment_string += &stringify_segment(*prefix);
     }
-    
+
     segment_string += &style.paint(value).to_string();
 
     if let Some(suffix) = suffix {