I spent today doing various things:
- Coming to grips with the bitstreams module, including:
- Turning some top-level functions into methods.
- Figuring out what I actually want to include in the documentation.
- And improving the names of classes and variables.
- Adding, and then removing, a nox session for running metrics against the code. Like, what's the point of metrics if the tool's Halstead metrics *cough* don't work, and the McCabe metrics are just a bunch of 1s and 2s, a few 3s, and a 7? Maybe there are better metrics, but the only other one I've seen people talking about is cognitive complexity, which incentivized some... interesting... code in Structured Data. I hope there's better stuff out there I haven't heard of, but if there is, I... haven't heard of it.
What got me in a good place with the code was writing comments on how visible I want each thing to be in the documentation. From there, I was able to use those notes to get a handle on the big picture. It's possible I'll end up wanting to rewrite some of this, but I'll document everything first and see what I think.
Things are going well, and I should wrap up for now.