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

Fix wrong name for driver options in docs #3074

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

alcaeus
Copy link
Member

@alcaeus alcaeus commented Jul 25, 2024

The docs use driverOptions as key in the connection config, but the connection class actually checks the driver_options key. Since the latter name has been in use for a while, I figured that the docs were wrong and updated the documentation so that the configuration is properly accepted.

@alcaeus alcaeus requested a review from GromNaN July 25, 2024 06:47
@alcaeus alcaeus requested a review from a team as a code owner July 25, 2024 06:47
@github-actions github-actions bot added the docs label Jul 25, 2024
Copy link
Member

@GromNaN GromNaN left a comment

Choose a reason for hiding this comment

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

Good catch.

if (isset($config['driver_options']) && is_array($config['driver_options'])) {
$driverOptions = $config['driver_options'];
}

@GromNaN GromNaN requested a review from rustagir July 25, 2024 06:56
@alcaeus alcaeus enabled auto-merge (squash) July 25, 2024 07:34
Copy link

@friday-deployer friday-deployer left a comment

Choose a reason for hiding this comment

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

Good to go

Copy link
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

LGTM

@alcaeus alcaeus merged commit 432456b into mongodb:4.7 Jul 30, 2024
26 checks passed
@alcaeus alcaeus deleted the fix-wrong-option-name branch July 30, 2024 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants