I noticed there were some issues with pydocs interpreting the docstrings on my functions so I've spent some time working on the documentation.
- Added a script for generating the documentation on macos.
- It's nearly identical but I guess either
sed
or the piping works a little differently.
- It's nearly identical but I guess either
- Made the typing annotations more uniform.
- I think this is a decent way to document keyword arguments:
- Treat them like a regular argument but prefix the name with
**
, then explain more in an example.
- Treat them like a regular argument but prefix the name with