I mean I get it that it’s a Long function, line wise, but it reads like every single line has just the minimum amount of information it needs to have to be legible and to make sense for it to exist.
I would say that this is more readable than those leet programmer regex hacks that work magic in 3 lines of code but require a fucking PhD to decipher.
Any guide on how to write effective logs? I’m starting to write scripts to automate some processes at my job and want to start logging the process to debugging or troubleshooting in the future.
The most useful thing you can do for simple scripts is never use the same log string in two locations in your code. If you reuse strings it can become very confusing where a specific log line printed from. In addition, write logs that let you trace the execution of the program, down to some kind of identifier that allows you to determine (for example) the exact iteration of a loop that caused an error.
I’d use logger that prints the file and line number when logging, to avoid the question of: “where is the log coming from”
I may put this on a slide for the Code Smells part of Refactoring lecture I have coming up.
There’s a semi-global
rthat is declared in a completely normal file and almost every file adds to it in some way.
