From 4df850973f663c387567fbbadfe3fa350200cca5 Mon Sep 17 00:00:00 2001
From: James Groom <OSSYoshiRulz@gmail.com>
Date: Sat, 24 Feb 2024 05:15:31 +1000
Subject: [PATCH] Document invariant

see df4aa7974
---
 src/BizHawk.Client.Common/display/IInputDisplayGenerator.cs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/BizHawk.Client.Common/display/IInputDisplayGenerator.cs b/src/BizHawk.Client.Common/display/IInputDisplayGenerator.cs
index d6c64beba2..ef6c1cdf2a 100644
--- a/src/BizHawk.Client.Common/display/IInputDisplayGenerator.cs
+++ b/src/BizHawk.Client.Common/display/IInputDisplayGenerator.cs
@@ -13,6 +13,7 @@ namespace BizHawk.Client.Common
 	/// </summary>
 	public class Bk2InputDisplayGenerator : IInputDisplayGenerator
 	{
+		/// <remarks>either <c>Range</c> or <c>Mnemonic</c> is always non-null</remarks>
 		private readonly IReadOnlyList<(string Name, AxisSpec? Range, char? Mnemonic)> _cachedInputSpecs;
 
 		private readonly IController _source;