From 21a9cf215a9e611e8f768bedca7ea970480b66ac Mon Sep 17 00:00:00 2001
From: nebel <9887+nebel@users.noreply.github.com>
Date: Sun, 21 Jul 2024 00:58:34 +0900
Subject: [PATCH] Add doc remark to RequestRedraw

---
 Dalamud/Plugin/Services/INamePlateGui.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Dalamud/Plugin/Services/INamePlateGui.cs b/Dalamud/Plugin/Services/INamePlateGui.cs
index 6fdc02bd3..713d9120b 100644
--- a/Dalamud/Plugin/Services/INamePlateGui.cs
+++ b/Dalamud/Plugin/Services/INamePlateGui.cs
@@ -39,5 +39,10 @@ public interface INamePlateGui
     /// <summary>
     /// Requests that all nameplates should be redrawn on the following frame.
     /// </summary>
+    /// <remarks>
+    /// This causes extra work for the game, and should not need to be called every frame. However, it is acceptable to
+    /// call frequently when needed (e.g. in response to a manual settings change by the user) or when necessary (e.g.
+    /// after a change of zone, party type, etc.).
+    /// </remarks>
     void RequestRedraw();
 }