Fix incorrect documentation, add missing @Override annotation #4209
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
I came across some incorrect documentation earlier today, so I decided to fix it.
Modifications
A few methods claim in their documentation that they return the query parameters of an HTTP request, but the methods actually return the headers of the request. I updated the documentation to reflect the correct behavior, and added a missing
@Override
annotation onto one of the affected methods.Testing
This change doesn't require any testing, but I ran
./mvnw clean install
anyway, which succeeded.Screenshots (if appropriate)
N/A
Types of changes
Checklist
mvn install
succeedsscripts/new-change
script and following the instructions. Commit the new file created by the script in.changes/next-release
with your changes.I'm encountering a weird issue on my Windows environment that's preventing me from creating a new changelog entry. If this is necessary, I can clone my fork on a different environment and generate it.
License