Twitter.jl
Twitter.jl copied to clipboard
randyzwitch
Make Proper Docs
Hey @randyzwitch!
It seems the next step for this package is to make proper documentation. I've fiddled with the Documenter.jl package, and I think I can manage this.
I have two questions before diving in: 1) Do I expand out all the macrogenerated functions so that we can make real docstrings for them? 2) Do we want to make every function visible in the docs or just the ones that get exported? Pardon my ignorance here.... Thanks!
For # 2, I would definitely only do the public API. If a user isn't expected to use a function, then documenting it just adds noise.
For question # 1, I think expanding the functions might be the easiest way, if you want to use Documenter. The alternative could be to use Franklin.jl (static site generator), but then the documentation won't automatically update. Up to you how you want to do it...while Documenter is great for rapidly changing projects and always being in sync, there isn't much change to this package API, so it's likely not a huge effort to manually keep things in sync.
Got it, cool. I have played around with Documenter, but not Franklin. I'll check it out and make a call. Thanks!
There is also https://github.com/tlienart/PkgPage.jl now which uses Franklin but brings a standard template that is used by other packages.
