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

Improve docs for HeaderApiVersionReader #1086

Open
1 task done
voroninp opened this issue Apr 29, 2024 · 0 comments · May be fixed by #1087
Open
1 task done

Improve docs for HeaderApiVersionReader #1086

voroninp opened this issue Apr 29, 2024 · 0 comments · May be fixed by #1087
Assignees

Comments

@voroninp
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

I believe it's important to properly manage expectations. As HeaderApiVersionReader has a default constructor, one may expect there is a default header. And this is not true. It's better to be explicit about what is required for the class to perform its duties.

Describe the solution you'd like

While completely removing default constructor would be a breaking change, I believe it's worth adding xmldoc remarks, explaining that HeaderNames must be initialized.

Additional context

No response

@voroninp voroninp changed the title Imrpove docs for HeaderApiVersionReader Improve docs for HeaderApiVersionReader Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants