Coding 2024-07-24

By Max Woerner Chase

I've just gone through several different tools for checking docstrings, and settled on what appears to be the least bad one, although it is... not great. I feel like if a tool is going to try to tell me whether I've used an iterator type in a return annotation, "evaluating type aliases" should be table stakes. I'm not expanding them! The full annotations are disasters, and I need the aliases to make it possible to write these annotations, let alone read them.

Anyway, I did manage to improve the documentation a bunch, I think. In order to tell, I need to finish setting up Sphinx, which never feels quite natural to me in the context of documenting Python code, the thing it was designed to do.

I think I'll try to work on test coverage for a bit, but to do that, I need to make some decisions about code behavior, and I'll have to sleep on some of the relevant questions there. It's already too late right now, so I'm going to wrap up as soon as I can and get to bed.

Good night.