From 5ee500526a37b708022fab401eed1298f2bfaa6c Mon Sep 17 00:00:00 2001 From: Vectornaut Date: Fri, 3 Oct 2025 20:47:10 +0000 Subject: [PATCH] Talk about tracking flags --- Code-flags.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Code-flags.md b/Code-flags.md index 1cd27bc..d4a57f6 100644 --- a/Code-flags.md +++ b/Code-flags.md @@ -2,4 +2,6 @@ In the source code, we're using the following flags to mark things we'd like to - `/* 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 +- `/* 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). + +Searching the source code for these flags can be a good way to remind ourselves of what we want to do. At some point, it might be nice to set up a system for giving each flag a corresponding issue. \ No newline at end of file