Skip to content

Commit

Permalink
chore: Add remarks to xmldoc for default constructor of HeaderApiVers…
Browse files Browse the repository at this point in the history
…ionReader

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.
  • Loading branch information
voroninp authored and Pavel Voronin committed Apr 29, 2024
1 parent 3fc0719 commit efea3a6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/Common/src/Common/HeaderApiVersionReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit efea3a6

Please sign in to comment.