[SERVER-42168] assert_util.h needs documentation Created: 11/Jul/19  Updated: 12/Jul/19  Resolved: 12/Jul/19

Status: Closed
Project: Core Server
Component/s: Internal Code
Affects Version/s: 4.3 Desired
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Billy Donahue Assignee: Billy Donahue
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates SERVER-42169 assert_util.h needs documentation Backlog
Participants:

 Description   

The wiki describes how to choose among our asserts. Engineers chronically choose the wrong assertion style. The header itself has no documentation. We could provide a link to that wiki page at a minimum and maybe that would help.

https://wiki.corp.mongodb.com/display/HGTC/MongoDB+Assertions+and+You

One problem with this is that the wiki is not accessible outside the company.


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