update documentation to make it clearer between seconds and milliseconds #46364
Conversation
This file contains hidden or 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
browndav-msft
requested review from
seanmcc-msft,
ibrandes,
kyleknap,
alzimmermsft and
gunjansingh-msft
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation in the Azure Storage Common library to clarify units of time measurement (seconds vs milliseconds) in retry-related methods and parameters. The changes address customer confusion about time units as referenced in issue #45373.
- Corrected default values in constructor documentation to show milliseconds (4ms → 4_000ms, 30ms → 30_000ms, 120ms → 120_000ms)
- Updated method documentation to explicitly specify when values are in seconds vs milliseconds
- Fixed a minor grammatical error in a method comment
.../azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
Outdated
Show resolved
Hide resolved
.../azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
Outdated
Show resolved
Hide resolved
ibrandes
reviewed
Aug 13, 2025
.../azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
Outdated
Show resolved
Hide resolved
ibrandes
reviewed
Aug 13, 2025
.../azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
Outdated
Show resolved
Hide resolved
ibrandes
reviewed
Aug 13, 2025
.../azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
Show resolved
Hide resolved
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.
Updated documentation to clarify the issue that the customer was having in #45373.
This makes it clearer whether something is in seconds or milliseconds.