[CDRIVER-4620] Docs incorrectly show bson_iter_as_double returns a bool Created: 18/Apr/23 Updated: 28/Oct/23 Resolved: 07/Jun/23 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | 1.24.0 |
| Type: | Task | Priority: | Unknown |
| Reporter: | Shane Harvey | Assignee: | Josh Siegel (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | neweng | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
SummaryThe docs say that bson_iter_as_double returns a bool:
http://mongoc.org/libbson/current/bson_iter_as_double.html This should be changed to:
MotivationWho is the affected end user?Who are the stakeholders? How does this affect the end user?Are they blocked? Are they annoyed? Are they confused? How likely is it that this problem or use case will occur?Main path? Edge case? If the problem does occur, what are the consequences and how severe are they?Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete? Is this issue urgent?Does this ticket have a required timeline? What is it? Is this ticket required by a downstream team?Needed by e.g. Atlas, Shell, Compass? Is this ticket only for tests?Does this ticket have any functional impact, or is it just test improvements? Acceptance CriteriaWhat specific requirements must be met to consider the design phase complete? |
| Comments |
| Comment by Githook User [ 07/Jun/23 ] |
|
Author: {'name': 'Joshua Siegel', 'email': '39130209+joshbsiegel@users.noreply.github.com', 'username': 'joshbsiegel'}Message: |