improve docs and rename model_customisation

1 files changed, 5 insertions, 1 deletions

diff --git a/azalea-client/src/player.rs b/azalea-client/src/player.rs
index b8ca83bb..3680e2d0 100755
--- a/azalea-client/src/player.rs
+++ b/azalea-client/src/player.rs
@@ -13,12 +13,16 @@ use crate::{packet_handling::AddPlayerEvent, GameProfileComponent};
 /// A player in the tab list.
 #[derive(Debug, Clone)]
 pub struct PlayerInfo {
+    /// Information about the player's Minecraft account, including their
+    /// username.
     pub profile: GameProfile,
     /// The player's UUID.
     pub uuid: Uuid,
     pub gamemode: GameType,
     pub latency: i32,
-    /// The player's display name in the tab list.
+    /// The player's display name in the tab list, but only if it's different
+    /// from the player's normal username. Use `player_info.profile.name` to get
+    /// the player's actual username.
     pub display_name: Option<FormattedText>,
 }