Came across some code which is subjected to a complexity analysis tool; the tool, called "lizard", has a specific annotation you can add in a comment to request it skip a function, which results in a rather alarming line of code without knowing that context:
// #lizard forgives
Replying to @0xabad1dea@infosec.exchange
I'm now imagining a whole pantheon that you have to proactively invoke for different flaws that you know your code contains. Athena forgives this lack of wisdom. Thor forgives this waste of electricity. Shennong forgives this lack of test coverage
Replying to @0xabad1dea@infosec.exchange
@0xabad1dea Linter rule naming scheme unlocked.
Replying to @d_rift@beige.party
@d_rift @0xabad1dea Okay actually honestly tho, linter or # TODO(...): categorization scheme?
Like, I've been trying to grow some sort of annotation-habit that would theoretically let me grep (or extensions thereof) for a given specific pattern of failures across the codebase to handle them one-pattern-at-a-time,
and haven't succeeded much yet,
and honestly maybe marking them up as "what kind of sin is this, which abstract folkloric category will need to forgive me for this" might actually work there.
Like, like the `// athena: forgive this lack of wisdson` -- `// TODO(arachne forgive the insufficient weaving of the type system here): ...` or `# TODO(janus forgive my compatibility issues): ...` or `; TODO(aphrodite forgive this lack of elegance): ...` or `<!-- TODO(sysiphus forgive this drudgery): ... -->` or ...
Replying to @gaditb@icosahedron.website
@gaditb @d_rift @0xabad1dea@infosec.exchange there are ways to type "// TODO" so IDEs can pick them up & list them all (across multilple files) in a "todo" window
example [here](https://www.jetbrains.com/help/idea/using-todo.html) this may be javadoc style, which is a common way of formatting code. unfortunately, I've also seen other "todo" styles in othe IDEs
IntelliJ IDEA HelpTODO comments | IntelliJ IDEA