[CDRIVER-2099] Undocument oldest deprecated functions Created: 24/Mar/17 Updated: 12/May/23 Resolved: 12/May/23 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | 1.24.0 |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | A. Jesse Jiryu Davis | Assignee: | Kevin Albertson |
| Resolution: | Done | Votes: | 0 |
| Labels: | neweng | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Quarter: | FY24Q2 |
| Description |
|
Rather than rev to 2.0 and actually break API, an alternative way to clean up the user experience of the driver is to remove the oldest and most-regretted APIs from the documentation. This will make it clearer to readers which functions are recommended to accomplish a given task. |
| Comments |
| Comment by Githook User [ 12/May/23 ] |
|
Author: {'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}Message:
The documentation suggests using bson_oid_init as an alternative.
And uses consistent verbage.
|
| Comment by Kevin Albertson [ 06/Mar/23 ] |
|
I suggest removing documentation for API with the BSON_GNUC_DEPRECATED attribute. |