Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add remarks to xmldoc for default constructor of HeaderApiVersionReader #1087

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

voroninp
Copy link

chore: Add remarks to xmldoc for default constructor of HeaderApiVersionReader

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • 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

…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.
@voroninp
Copy link
Author

@commonsensesoftware , what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve docs for HeaderApiVersionReader
1 participant