Skip to content

Commit efea3a6

Browse files
voroninpPavel Voronin
authored and
Pavel Voronin
committed
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.
1 parent 3fc0719 commit efea3a6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/Common/src/Common/HeaderApiVersionReader.cs

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ public partial class HeaderApiVersionReader : IApiVersionReader
1515
/// <summary>
1616
/// Initializes a new instance of the <see cref="HeaderApiVersionReader"/> class.
1717
/// </summary>
18+
/// <remarks>
19+
/// There is no default header. Either initialize headers using the <see cref="HeaderNames"/> collection property,
20+
/// or call a constructor that accepts header names. Otherwise, this reader has no effect.
21+
/// </remarks>
1822
public HeaderApiVersionReader() { }
1923

2024
/// <summary>

0 commit comments

Comments
 (0)