Hi Andreas,
There’s no style guide specific to Julia that I’m aware of. Your best bet would probably be to have a look to how other languages go about documenting and extract the parts that make the most sense to you. Beyond that I’d just suggest documenting each thing that you export from your module (documenting internals can also be done with Docile, but since the user isn’t going to be interacting with those parts it *might* not be as important). A short one line description followed by a longer discussion if needed of each major function/method/type/etc. A sentence or two for each argument that a method takes. Perhaps the return type that’s expected and whether an exception might be thrown. A simple example showing the usage can also be helpful. I’m sure this isn’t an exhaustive list and others on this list who write software for a living could improve on it, but hopefully it’ll push you in the right direction. — Mike
