Skip to content

Improve docs for HeaderApiVersionReader #1086

Open
@voroninp

Description

@voroninp

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

Activity

changed the title [-]Imrpove docs for HeaderApiVersionReader[/-] [+]Improve docs for HeaderApiVersionReader[/+] on Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Participants

    @voroninp@commonsensesoftware

    Issue actions

      Improve docs for HeaderApiVersionReader · Issue #1086 · dotnet/aspnet-api-versioning