From 15fcabb1282c8c36c4f005e6acba36a7d239fb11 Mon Sep 17 00:00:00 2001
From: Salman Ahmed <frenzibyte@gmail.com>
Date: Mon, 1 Feb 2021 22:04:44 +0300
Subject: [PATCH] Add documentation to auto-scroll leniency
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Bartłomiej Dach <dach.bartlomiej@gmail.com>
---
 osu.Game/Overlays/Chat/DrawableChannel.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/osu.Game/Overlays/Chat/DrawableChannel.cs b/osu.Game/Overlays/Chat/DrawableChannel.cs
index 4c8513b1d5..0cd5ecc05a 100644
--- a/osu.Game/Overlays/Chat/DrawableChannel.cs
+++ b/osu.Game/Overlays/Chat/DrawableChannel.cs
@@ -241,6 +241,11 @@ namespace osu.Game.Overlays.Chat
         /// </summary>
         private class ChannelScrollContainer : OsuScrollContainer
         {
+            /// <summary>
+            /// The chat will be automatically scrolled to end if and only if
+            /// the distance between the current scroll position and the end of the scroll
+            /// is less than this value.
+            /// </summary>
             private const float auto_scroll_leniency = 10f;
 
             private float? lastExtent;