Skip to content

GODRIVER-3420 Clarify docs and comments. #1897

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 21, 2024
Merged

GODRIVER-3420 Clarify docs and comments. #1897

merged 1 commit into from
Nov 21, 2024
+50 −22

Conversation

@qingyang-hu
Copy link
Collaborator

@qingyang-hu qingyang-hu commented Nov 18, 2024

GODRIVER-3420

Summary

Clarify docs and comments.

  • Explicitly call out bson.M unmarshaling behavior changes.
  • Update package names in comments.

Background & Motivation

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added documentation Pull requests that update documentation or examples review-priority-low Low Priority PR for Review: within 3 business days labels Nov 18, 2024
@mongodb-drivers-pr-bot
Copy link
Contributor

mongodb-drivers-pr-bot bot commented Nov 18, 2024

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 14:44
@matthewdale matthewdale added review-priority-urgent High Priority PR for Review: review immediately! and removed review-priority-low Low Priority PR for Review: within 3 business days labels Nov 19, 2024
matthewdale
matthewdale approved these changes Nov 21, 2024
View reviewed changes
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 17aeb0b into mongodb:master Nov 21, 2024
29 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matthewdale matthewdale matthewdale approved these changes

@prestonvasquez prestonvasquez prestonvasquez approved these changes

Assignees

No one assigned

Labels

documentation Pull requests that update documentation or examples review-priority-urgent High Priority PR for Review: review immediately!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@qingyang-hu @matthewdale @prestonvasquez