seantronsen / pvt

GNU General Public License v3.0

0 stars 0 forks source link

Another Round of Refactoring, Cleanup, Documenting, and Testing #31

Open seantronsen opened 7 months ago

seantronsen commented 7 months ago

Several feature requests have recently been implemented and it would be wise to go through the source code again and make sure everything is tidied up to simplify adding features in the future (remove spaghetti).

seantronsen commented 6 months ago

Several new features have been added recently. They need to have unit tests written for them and benchmarks to ensure we aren't slowing things down.

Examples:

34

seantrons commented 6 months ago

Need to add sphinx docs for this project with doc tests and the whole works. I don't plan on having a hosting website for it any time soon, but we can provide users the command to generate the docs in the README.md file.

That or it could be wise to create a Wiki page through github for this project containing a variety of usage recipes (cookbook style).

seantrons commented 6 months ago

More documentation via comments and docstrings was added during the repository changes made for #39