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

GODRIVER-3425 Reference ObjectIdAsHexString decoder option in exception message. #1896

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

qingyang-hu
Copy link
Collaborator

GODRIVER-3425

Summary

Reference ObjectIdAsHexString decoder option in exception message.

Background & Motivation

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added the priority-3-low Low Priority PR for Review label Nov 18, 2024
Copy link
Contributor

API Change Report

./v2/mongo/options

incompatible changes

(*ClientOptionsBuilder).SetDriverInfo: removed
ClientOptions.DriverInfo: removed
DriverInfo: removed

./v2/x/mongo/driver/auth

incompatible changes

HandshakeOptions.OuterLibraryName: removed
HandshakeOptions.OuterLibraryPlatform: removed
HandshakeOptions.OuterLibraryVersion: removed

./v2/x/mongo/driver/operation

incompatible changes

(*Hello).OuterLibraryName: removed
(*Hello).OuterLibraryPlatform: removed
(*Hello).OuterLibraryVersion: removed

./v2/x/mongo/driver/topology

incompatible changes

WithOuterLibraryName: removed
WithOuterLibraryPlatform: removed
WithOuterLibraryVersion: removed

@qingyang-hu qingyang-hu marked this pull request as ready for review November 19, 2024 16:24
@matthewdale matthewdale added priority-1-high High Priority PR for Review and removed priority-3-low Low Priority PR for Review labels Nov 19, 2024
matthewdale
matthewdale previously approved these changes Nov 20, 2024
Copy link
Collaborator

@matthewdale matthewdale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, with a suggestion. 👍

Comment on lines 61 to 62
msg := "decoding an object ID into a plain string is not supported " +
"(set Decoder.ObjectIDAsHexString to enable decoding as a hexadecimal representation)"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Use a const and slightly clearer wording.

Suggested change
msg := "decoding an object ID into a plain string is not supported " +
"(set Decoder.ObjectIDAsHexString to enable decoding as a hexadecimal representation)"
const msg = "decoding an object ID into a string is not supported by default" +
"(set Decoder.ObjectIDAsHexString to enable decoding as a hexadecimal string)"

Copy link
Collaborator

@matthewdale matthewdale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

@qingyang-hu qingyang-hu merged commit 1ada5fa into mongodb:master Nov 21, 2024
32 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-1-high High Priority PR for Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants