Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Developer Infrastructure, Stack Documentation and UX
-
Story Points:6
-
Epic Link:
-
Sprint:Alert Production F16 - 11, Alert Production F16 - 11b, Alert Production F16 - 11c, Alert Production S17 - 12, Alert Production S17 - 1, Alert Production S17 - 2
-
Team:Alert Production
Description
Modify the page Documenting C++ Code in the LSST Developer Guide to conform to RFC-225, including changes made in the discussion section. The final result should look similar to Documenting Python APIs.
The page is considered part of the C++ Style Guide, so these changes must be approved by the System Architect. They should also be approved by as many senior C++ developers as is practical.
For what it's worth, I agree with Jonathan Sick about cross-references.