Notes

Here's a place for miscellaneous notes.

Tools

simpler syntax for doctests: use xdoctest

I've definitely leaned towards xdoctests (mentioned in ci channel I think). My only hesitation: That it's not builtin, so need extra setup anywhere we want to use it. At the very least: IDE CI Of course, there's ways to integrate in both, it's just that doctests work out of the box. That said, builtin doctest are so annoying to work with that it adds a lot of boilerplate and discourages people to use them, so as a result, they don't. So basically, probably worth at least trying out...

blackdocs

All for more normalization. Also, this may solve some of our doctest problems (which would make us not need xdoctest. As far as I understand: xdoctest offers a different (more convenient, less boilerplate) way to read the doctests blackdocs offers a way to rewrite docs, in including doctests. The ideal (which either maybe already provides, is if we can have a process that rewrites doctests in such a way as to make them directly interpretable by builtin doctests.

types autodoc

useful if we want to continue doing rst style, but with more convenient type specification But if we use google style, we don't need that.

alternative to sphinx: lazydocs for MkDocs.

if we were using mkdocs, maybe -- and if we were to redo wads, isee, and epythet, probably.