[GODRIVER-2682] Rename "bson.NewFromIOReader" to "bson.ReadDocument" Created: 10/Dec/22  Updated: 28/Oct/23  Resolved: 07/Apr/23

Status: Closed
Project: Go Driver
Component/s: BSON
Affects Version/s: None
Fix Version/s: 1.12.0

Type: Improvement Priority: Unknown
Reporter: Matt Dale Assignee: Matt Dale
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by GODRIVER-2617 Remove or un-export all currently dep... Closed
Related
is related to GODRIVER-2606 Deprecate unused functionality in pre... Closed
Epic Link: Go Driver 2.0 Prep
Quarter: FY24Q1
Documentation Changes: Not Needed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

The function bson.NewFromIOReader is non-intuitively named. Replace it with a function with a more intuitive name.

Definition of done:

  • Add a new function called bson.ReadDocument that does exactly the same thing as bson.NewFromIOReader
  • Deprecate bson.NewFromIOReader. Suggest using bson.ReadDocument


 Comments   
Comment by Githook User [ 06/Apr/23 ]

Author:

{'name': 'Matt Dale', 'email': '9760375+matthewdale@users.noreply.github.com', 'username': 'matthewdale'}

Message: GODRIVER-2682 Prepare to rename bson.NewFromIOReader to bson.ReadDocument. (#1217)

Co-authored-by: Preston Vasquez <prestonvasquez@icloud.com>
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/fc24f61ff40fa650a51fa735e2697a6565c47bf8

Comment by Matt Dale [ 03/Apr/23 ]

PR: https://github.com/mongodb/mongo-go-driver/pull/1217

Generated at Thu Feb 08 08:39:08 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.