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

Inaccurate documentation in code comments for CosmosThresholdOptions #4351

Closed
OptimusPi opened this issue Mar 15, 2024 · 0 comments · Fixed by #4357
Closed

Inaccurate documentation in code comments for CosmosThresholdOptions #4351

OptimusPi opened this issue Mar 15, 2024 · 0 comments · Fixed by #4357
Labels
customer-reported Issue created by a customer needs-investigation

Comments

@OptimusPi
Copy link

We are continuously addressing and improving the SDK, if possible, make sure the problem persist in the latest SDK version.

Describe the bug
public class CosmosThresholdOptions has inaccurate code comments which may confuse users inspecting the code comments through IntelliSense, while the coder is configuring a Microsoft.Azure.Cosmos Client using CosmosThresholdOptions.

NonPointOperationLatencyThreshold is documented as "500 ms" but the value is 3 seconds.
PointOperationLatencyThreshold is documented as "100 ms" but the value is 1 second.

To Reproduce
Hover and inspect CosmosThresholdOptions.NonPointOperationLatencyThreshold

Expected behavior
The comments for CosmosThresholdOptions Value should match the default value in the code
IntelliSense hint based on the code comment documentation should say "3000 ms" or "3 s"

Actual behavior
image

image

Environment summary
SDK Version: latest
OS Version (e.g. Windows, Linux, MacOSX): N/A

Additional context
Original doc here:
https://github.com/Azure/azure-cosmos-dotnet-v3/pull/4056/files#r1334739506

Current state, the code comment changed formats but is still inaccurate:
https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/Microsoft.Azure.Cosmos/src/CosmosThresholdOptions.cs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-reported Issue created by a customer needs-investigation
Projects
None yet
2 participants