There should be a link to online document
Closed this issue · 9 comments
What online document?
The one generated by autodoc. There should be a choice other than looking at source code.
Ah, gotcha! Yeah, I should put up some generated documentation. Thanks for pointing this out!
+1. There's no way to see what this library does or what it offers without looking at the source, which isn't a great experience. Even just listing a few of the key functions in the readme would help.
Actually, looking at the source is nearly the same experience. If you compare documentation generated with something like codox, it's basically the same as the source without the bodies of the functions. ;)
Sounds good, but let's at least state in the readme "to see the available functionality, view the [source]" where [source] is a like to the relevant file. My first instinct was to grep the readme and then google for docs rather than digging through the project's directory structure.
I'm still gonna throw up some codox documentation. I was just being a smartass.
Awesome! Thanks