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

docs(NODE-4349): add note about Binary(string) behavior #504

Merged
merged 2 commits into from
Jun 29, 2022

Conversation

addaleax
Copy link
Contributor

Description

What is changing?

Adds a note that Binary(string) is probably not what you want unless you really know what you’re doing.

(This was inspired by old Compass code getting this wrong in at least one place.)

Is there new documentation needed for these changes?

This is a doc change.

What is the motivation for this change?

Double check the following

  • Ran npm run lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

src/binary.ts Outdated Show resolved Hide resolved
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Jun 28, 2022
@durran durran added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Jun 28, 2022
@nbbeeken nbbeeken changed the title chore(NODE-4349): add note about Binary(string) behavior docs(NODE-4349): add note about Binary(string) behavior Jun 29, 2022
@nbbeeken nbbeeken merged commit 5475378 into mongodb:main Jun 29, 2022
@addaleax addaleax deleted the 4349-dev branch June 30, 2022 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
3 participants