aspnet-api-versioning icon indicating copy to clipboard operation
aspnet-api-versioning copied to clipboard

chore: Add remarks to xmldoc for default constructor of HeaderApiVersionReader

Open voroninp opened this issue 1 year ago • 1 comments

chore: Add remarks to xmldoc for default constructor of HeaderApiVersionReader

  • [x] You've read the Contributor Guide and Code of Conduct.
  • [x] You've included unit or integration tests for your change, where applicable.
  • [x] You've included inline docs for your change, where applicable.
  • [x] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Description

It's easy to make a mistake expecting some defaults which are simply absent. It's worth to be more explicit in the docs, and explain, that headers must be set.

Fixes #1086

voroninp avatar Apr 29 '24 19:04 voroninp

@commonsensesoftware , what do you think?

voroninp avatar Jul 24 '24 12:07 voroninp