docs: add warning about single not being threadsafe

bUnit-dev · Oct 14, 2023 · 8c579d3 · 8c579d3
1 parent 326eb2d
commit 8c579d3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/bunit.web/Diffing/DiffMarkupFormatter.cs b/src/bunit.web/Diffing/DiffMarkupFormatter.cs
@@ -12,6 +12,10 @@ public class DiffMarkupFormatter : PrettyMarkupFormatter, IMarkupFormatter
 	/// <summary>
 	/// Gets an instance of the <see cref="DiffMarkupFormatter"/>.
 	/// </summary>
+	/// <remarks>
+	/// The <see cref="DiffMarkupFormatter"/> is not thread safe, so using this singleton
+	/// instance to format elements may not result in the desired effect.
+	/// </remarks>
 	public static new readonly DiffMarkupFormatter Instance = new();
 
 	/// <summary>