chore: Make style of TODOs consistent (#1332)

Co-authored-by: Oscar Spencer <oscar@grain-lang.org>

Author: spotandjake

compiler/graindoc/docblock.re

@@ -258,7 +258,7 @@ let to_markdown = (~current_version, docblock) => {
       deprecations,
     );
   };
-  // TODO: Should we fail if more than one `@since` attribute?
+  // TODO(#787): Should we fail if more than one `@since` attribute?
   let since_attr =
     docblock.attributes
     |> List.find_opt(Comments.Attribute.is_since)

compiler/graindoc/graindoc.re

@@ -86,7 +86,7 @@ let generate_docs =
   let module_comment = Comments.Doc.find_module(comments);
   switch (module_comment) {
   | Some((_, desc, attrs)) =>
-    // TODO: Should we fail if more than one `@module` attribute?
+    // TODO(#787): Should we fail if more than one `@module` attribute?
     let module_attr = attrs |> List.find(Comments.Attribute.is_module);
     switch (module_attr) {
     | Module({attr_name, attr_desc}) =>
@@ -100,7 +100,7 @@ let generate_docs =
     | _ => failwith("Unreachable: Non-`module` attribute can't exist here.")
     };
 
-    // TODO: Should we fail if more than one `@since` attribute?
+    // TODO(#787): Should we fail if more than one `@since` attribute?
     let since_attr =
       attrs
       |> List.find_opt(Comments.Attribute.is_since)

compiler/src/codegen/compcore.re

@@ -9,9 +9,6 @@ open Comp_wasm_prim;
 
 let sources: ref(list((Expression.t, Grain_parsing.Location.t))) = ref([]);
 
-/* [TODO] Should probably be a config variable */
-let memory_debugging_enabled = false;
-
 /** Environment */
 
 type codegen_env = {
@@ -1298,7 +1295,7 @@ let compile_array_op = (wasm_mod, env, arr_imm, op) => {
             ),
             get_arr(),
           ),
-          /* [TODO] decref the old item more efficiently (using a swap slot, most likely) */
+          // TODO: decref the old item more efficiently (using a swap slot, most likely)
           Expression.Tuple_extract.make(
             wasm_mod,
             Expression.Tuple_make.make(
@@ -2375,7 +2372,7 @@ let compile_prim0 = (wasm_mod, env, p0): Expression.t => {
 
 let compile_prim1 = (wasm_mod, env, p1, arg, loc): Expression.t => {
   let compiled_arg = compile_imm(wasm_mod, env, arg);
-  /* TODO: Overflow checks? */
+  // TODO: Overflow checks?
   switch (p1) {
   | AllocateArray => allocate_uninitialized_array(wasm_mod, env, arg)
   | AllocateTuple => allocate_uninitialized_tuple(wasm_mod, env, arg)
@@ -2482,7 +2479,7 @@ let compile_prim1 = (wasm_mod, env, p1, arg, loc): Expression.t => {
       ],
     )
   | Throw =>
-    // [TODO] When we have exception handling, revisit whether there is any GC required here (#813)
+    // TODO(#813): When we have exception handling, revisit whether there is any GC required here
     Expression.Block.make(
       wasm_mod,
       gensym_label("throw"),

compiler/src/formatting/format.re

@@ -1483,7 +1483,7 @@ and print_record =
           switch (fields) {
           | [_one] =>
             // TODO: not needed once we annotate with ::
-            Doc.comma //  append a comma as single argument record look like block {data:val}
+            Doc.comma // append a comma as single argument record look like block {data:val}
           | _ => Doc.nil
           },
         ),

compiler/src/formatting/res_doc.re

@@ -230,7 +230,7 @@ let fits = (w, stack) => {
     | (Flat, IfBreaks({no: flatDoc})) => calculate(indent, mode, flatDoc)
     | (_, Concat(docs)) => calculateConcat(indent, mode, docs)
     | (_, CustomLayout([hd, ..._])) =>
-      /* TODO: if we have nested custom layouts, what we should do here? */
+      // TODO: if we have nested custom layouts, what we should do here?
       calculate(indent, mode, hd)
     | (_, CustomLayout([])) => ()
     }

compiler/src/middle_end/anftree.re

@@ -360,8 +360,8 @@ and comp_expression_desc =
   | CFloat32(float)
   | CFloat64(float)
 
-/** Compound expressions (possibly let-bound)
-    TODO: better name */
+/** Compound expressions (possibly let-bound) */
+// TODO: better name
 
 [@deriving sexp]
 and anf_expression = {

compiler/src/middle_end/anftree.rei

@@ -340,8 +340,8 @@ and comp_expression_desc =
   | CFloat32(float)
   | CFloat64(float)
 
-/** Compound expressions (possibly let-bound)
-    TODO: better name */
+/** Compound expressions (possibly let-bound) */
+// TODO: better name
 
 [@deriving sexp]
 and anf_expression = {

compiler/src/middle_end/matchcomp.re

@@ -649,8 +649,7 @@ let rec compile_matrix = mtx =>
       let constants = matrix_head_constants(mtx);
       let equality_type = equality_type(List.hd(constants));
 
-      // TODO: https://github.com/grain-lang/grain/issues/1185
-      // Optimize physical equality checks into a switch.
+      // TODO(#1185): Optimize physical equality checks into a switch.
       // We can also do partial switches on Numbers if some of the
       // patterns are stack-allocated numbers. Addtionally, since we
       // know the types of the non-Number number types, we can make

compiler/src/middle_end/optimize.re

@@ -55,6 +55,6 @@ let optimize_program = (prog: Anftree.anf_program): Anftree.anf_program => {
       pass(n - 1, opt);
     };
 
-  /* TODO: Make 4 a config value */
+  // TODO: Make 4 a config value
   pass(4, prog);
 };

compiler/src/typed/includemod.re

@@ -130,7 +130,7 @@ let type_declarations =
 
 let extension_constructors = (~loc, env, ~mark, cxt, subst, id, ext1, ext2) => {
   let mark = mark_positive(mark);
-  // TODO: Enable or remove (#324)
+  // TODO(#324): Enable or remove
   // let ext2 = Subst.extension_constructor(subst, ext2);
   if (Includecore.extension_constructors(~loc, env, ~mark, id, ext1, ext2)) {
     ();