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

📚 Doc: Add additional information as to why GetReqHeaders returns a map where the values are slices of strings #2698

Merged
merged 2 commits into from
Nov 1, 2023

Conversation

moritz157
Copy link
Contributor

Added additional information as to why GetReqHeaders returns a map where the values are slices of strings (instead of a single string as one might expect)

Description

In a (more or less) recent breaking change, the signature of GetReqHeaders was changed to return a map where the values are not single strings anymore but instead slices of strings. As someone who encountered this breaking change after upgrading fiber, it was not clear why this was changed and - more importantly - what exactly would be contained in these slices. Therefore I added a short and simple explanation what one can expect to be returned by this method.

Documents the intent of #2594

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

Added additional information to why GetReqHeaders returns a map where the values are slices of strings (instead of a single string as one might expect)
Copy link

welcome bot commented Nov 1, 2023

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Member

@efectn efectn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you update getrespheaders docs as well

added the same explanation to GetRespHeaders too
@moritz157
Copy link
Contributor Author

sure, done

@ReneWerner87 ReneWerner87 merged commit fe395b9 into gofiber:master Nov 1, 2023
1 check passed
Copy link

welcome bot commented Nov 1, 2023

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@ReneWerner87 ReneWerner87 added this to the v2 Next Release milestone Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants