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

Update docstring for FormValue() #2262

Merged
merged 1 commit into from Dec 5, 2022
Merged

Conversation

AngelVI13
Copy link
Contributor

@AngelVI13 AngelVI13 commented Dec 5, 2022

Description

Improve docstring for FormValue() to Include the other places that are searched for the provided form value key.

Context:
I was using FormValue() to get the contents of a MultipartForm, however, the request also had some query arguments with the same name. The value I got from FromValue() was the one from the query args and not from the multipart form. This was not expected since the documentation clearly stated that it is getting the value from a MultipartForm. I checked the implementation of FormValue() and saw that it is using fasthttp which explains the order of the search for form value as follows:

image

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

None of the above. Its just a doc fix.

Checklist:

  • For new functionalities I follow the inspiration of the express js framework and built them similar in usage
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation - https://github.com/gofiber/docs for https://docs.gofiber.io/
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • If new dependencies exist, I have checked that they are really necessary and agreed with the maintainers/community (we want to have as few dependencies as possible)
  • I tried to make my code as fast as possible with as few allocations as possible
  • For new code I have written benchmarks so that they can be analyzed and improved

Include the other places that are searched for the provided form value key
@welcome
Copy link

welcome bot commented Dec 5, 2022

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

@ReneWerner87 ReneWerner87 merged commit 356448c into gofiber:master Dec 5, 2022
@welcome
Copy link

welcome bot commented Dec 5, 2022

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

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.

None yet

2 participants