From e19036e96d592fc0197e97ce83eb18c8cba8a0a5 Mon Sep 17 00:00:00 2001 From: Vectornaut Date: Fri, 3 Oct 2025 20:41:13 +0000 Subject: [PATCH] Document the DEBUG and TO DO flags --- Code-flags.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Code-flags.md b/Code-flags.md index a0994eb..1cd27bc 100644 --- a/Code-flags.md +++ b/Code-flags.md @@ -1,3 +1,5 @@ -Within the source code, we're using the following flags to mark things we'd like to come back to. +In the source code, we're using the following flags to mark things we'd like to come back to. -- `/* KLUDGE */` A sloppy, awkward, or fragile way to get something working, which should eventually be replaced with something more polished, carefully designed, and robust. \ No newline at end of file +- `/* DEBUG */` Code that was added on the fly for debugging. It should eventually be either removed or replaced with more formal diagnostics, depending on whether we're finding it useful in the long term. +- `/* KLUDGE */` A sloppy, awkward, or fragile way to get something working. It should eventually be replaced with something more polished, elegant, and robust. +- `/* TO DO */` A task involving this code that we should eventually do. The task may be either circumscribed (like replacing a literal with a named constant) or open-ended (like looking into alternatives for an algorithm that we're using). The task may be blocked by tasks outside our control (like the stabilization of an experimental Rust feature). \ No newline at end of file