[CXX-1817] Rename get_utf8() to get_string() Created: 12/Sep/19  Updated: 05/Oct/21  Resolved: 14/Sep/20

Status: Closed
Project: C++ Driver
Component/s: None
Affects Version/s: None
Fix Version/s: 3.7.0, 3.7.0-beta1

Type: Improvement Priority: Major - P3
Reporter: Mathias Stearn Assignee: Raymund Rodriguez
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by CXX-2110 Remove all references to utf8 Backlog
Related
is related to CXX-2109 Deprecate all references to utf8 Closed
Epic Link: CXX-2082

 Description   

Using the name get_utf8 is not very user friendly. It is not what anyone would look for when trying to figure out how to get a string out of a bson element. To make it worse, "string" doesn't even show up in the documentation of the function, so you can't even find it when searching in the header or doxygen.

This should probably be done everywhere that utf8 is used to mean string.

You will probably need to leave the get_utf8 name available as a deprecated alias for a while.



 Comments   
Comment by Githook User [ 14/Sep/20 ]

Author:

{'name': 'rayangler', 'email': 'rayangler@users.noreply.github.com', 'username': 'rayangler'}

Message: CXX-1817 Rename get_utf8() to get_string() to make it more user-friendly (#721)
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/7ccc2d414526a57f208277fa9d44bd5ff14826e6

Generated at Wed Feb 07 22:04:01 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.