[cosmos] Correct documentation for enableBackgroundEndpointRefreshing default value #33093
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
heguro
requested review from
amanrao23,
aditishree1,
sajeetharan and
topshot99
as code owners
github-actions
bot
added
Community Contribution
|
Thank you for your contribution @heguro! We will review the pull request and get back to you soon. |
|
API change check API changes are not detected in this pull request. |
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.
Packages impacted by this PR
@azure/cosmosIssues associated with this PR
Describe the problem that is addressed by this PR
JSDoc comment and documentation incorrectly state that
enableBackgroundEndpointRefreshingdefaults to false, when the actual default value is true as shown in thedefaultConnectionPolicyobject:azure-sdk-for-js/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts
Line 50 in fe306bc
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
#15781 (implemented this parameter)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists