StudioInfinity/dyna3
2
0
Fork 2
Code Issues 65 Pull requests 2 Projects 3 Releases 4 Wiki Activity Actions

Talk about tracking flags

Vectornaut 2025-10-03 20:47:10 +00:00
parent e19036e96d
commit 5ee500526a
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Code-flags.md

@ -3,3 +3,5 @@ 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. - `/* 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. - `/* 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). - `/* 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.