more docs

1 files changed, 17 insertions, 1 deletions

diff --git a/azalea-chat/src/component.rs b/azalea-chat/src/component.rs
index 6dd11084..4df3796f 100755
--- a/azalea-chat/src/component.rs
+++ b/azalea-chat/src/component.rs
@@ -13,6 +13,7 @@ use crate::{
     translatable_component::{StringOrComponent, TranslatableComponent},
 };
 
+/// A chat component, basically anything you can see in chat.
 #[derive(Clone, Debug)]
 pub enum Component {
     Text(TextComponent),
@@ -57,7 +58,22 @@ impl Component {
         Ok(None)
     }
 
-    /// Convert this component into an ansi string
+    /// Convert this component into an
+    /// [ANSI string](https://en.wikipedia.org/wiki/ANSI_escape_code), so you
+    /// can print it to your terminal and get styling.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use azalea_chat::Component;
+    ///
+    /// let component = Component::deserialize(&serde_json::json!({
+    ///    "text": "Hello, world!",
+    ///    "color": "red",
+    /// })).unwrap();
+    ///
+    /// println!("{}", component.to_ansi());
+    /// ```
     pub fn to_ansi(&self, default_style: Option<&Style>) -> String {
         // default the default_style to white if it's not set
         let default_style: &Style = default_style.unwrap_or(&DEFAULT_STYLE);