Skip to content

docs(NODE-3650): Note that boolean options must now be specified as booleans in upgrade guide #3017

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

Merged
merged 3 commits into from
Oct 27, 2021

Conversation

kmahar
Copy link
Contributor

@kmahar kmahar commented Oct 26, 2021

Description

Driver 3.x would accept values such as 0 and 1 in place of booleans. We no longer accept them as of 4.0. This PR notes the change in the upgrade guide.

What is changing?

Added a section to the upgrade guide.

Is there new documentation needed for these changes?

This is documentation 🙂

What is the motivation for this change?

A user was confused by this behavior and posted on the community forums about it.

Double check the following

  • Ran npm run check:lint script (to be honest I didn't do this because I don't have a local dev environment set up, but I doubt this file gets linted 🙂)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
  • Changes are covered by tests (N/A)
  • New TODOs have a related JIRA ticket (N/A)

Copy link
Contributor

@dariakp dariakp left a comment

Choose a reason for hiding this comment

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

Super tiny clean up request

@dariakp dariakp added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Oct 26, 2021
Co-authored-by: Daria Pardue <[email protected]>
@kmahar kmahar requested a review from dariakp October 26, 2021 21:26
Copy link
Contributor

@dariakp dariakp left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@dariakp dariakp merged commit bed1cbf into main Oct 27, 2021
@dariakp dariakp deleted the NODE-3650/upgrade-guide-strict-booleans branch October 27, 2021 15:31
dariakp pushed a commit that referenced this pull request Nov 2, 2021
ljhaywar pushed a commit that referenced this pull request Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants