Expand comment about why P.3 'bad' code is unclear, closes #2058

3 years ago · 89a20b2cc8
parent 3c90d590e1
commit 89a20b2cc8
1 changed files with 3 additions and 1 deletions
--- a/CppCoreGuidelines.md
+++ b/CppCoreGuidelines.md
@ -644,7 +644,9 @@ Some language constructs express intent better than others.

 If two `int`s are meant to be the coordinates of a 2D point, say so:

-    draw_line(int, int, int, int);  // obscure
+    draw_line(int, int, int, int);  // obscure: (x1,y1,x2,y2)? (x,y,h,w)? ...?
+                                    // need to look up documentation to know
+
    draw_line(Point, Point);        // clearer

 ##### Enforcement