Fix comment for useAuthorizationHeader config. #4330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
t3chguy
approved these changes
Jul 26, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It looks like the default value for this config option was changed, but the comment wasn't updated. The comment at https://github.com/matrix-org/matrix-js-sdk/blob/develop/src/http-api/interface.ts#L56 was updated, and https://github.com/matrix-org/matrix-js-sdk/blob/develop/src/http-api/fetch.ts#L48 is where the default value gets applied.
And while I'm here, added a note that using the query param is deprecated.
Checklist
public/exportedsymbols have accurate TSDoc documentation.