From efea3a6e6e694a71ed354970deff728c14d9e467 Mon Sep 17 00:00:00 2001
From: Pavel Voronin <voroninp@gmail.com>
Date: Mon, 29 Apr 2024 20:44:42 +0200
Subject: [PATCH] chore: Add remarks to xmldoc for default constructor of
 HeaderApiVersionReader

It's easy to make a mistake expecting some defaults which are simply absent. I'd prefer getting rid of the default constructor, but that would be a breaking change.
It's worth to be more explicit in the docs, and explain, that headers must be set.
---
 src/Common/src/Common/HeaderApiVersionReader.cs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/Common/src/Common/HeaderApiVersionReader.cs b/src/Common/src/Common/HeaderApiVersionReader.cs
index 2bffbf31..e5bea98c 100644
--- a/src/Common/src/Common/HeaderApiVersionReader.cs
+++ b/src/Common/src/Common/HeaderApiVersionReader.cs
@@ -15,6 +15,10 @@ public partial class HeaderApiVersionReader : IApiVersionReader
     /// <summary>
     /// Initializes a new instance of the <see cref="HeaderApiVersionReader"/> class.
     /// </summary>
+    /// <remarks>
+    /// There is no default header. Either initialize headers using the <see cref="HeaderNames"/> collection property,
+    /// or call a constructor that  accepts header names. Otherwise, this reader has no effect.
+    /// </remarks>
     public HeaderApiVersionReader() { }
 
     /// <summary>