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

Document the DEBUG and TO DO flags

Vectornaut 2025-10-03 20:41:13 +00:00
parent 749b8be74d
commit e19036e96d
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
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.
- `/* 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).