-
-
Our GoDocs have a few issues:
- [x] Lots of `nolint: lll`
- [x] Markdown formatting not rendered looks a little awkward
- [ ] Sub-packages don't have any package level comments at all
- [ ] Most t…
-
README was written out in #5 .
A Godoc would be extremely useful so that someone who wants to use the library doesn't have to look at source code or examples.
There are two parts to this:
- […
-
-
It would be usefull to show examples of godoc comments, including the convention of starting the comment with the function name, or package.
https://blog.golang.org/godoc-documenting-go-code
-
We need to start documenting the project
* [ ] Document Native Query Types
* [ ] Document Native Query Components
-
Since the documentation is separate from the source, the standard tooling can't leverage it (godoc, gocode, sourcegraph, etc...). Is there a reason the docs are not in the source?
-
To improve the usability of this libary, one should create a GoDoc. This could also improve adoption.
Currently all librarys, even the ones from Google are badly documented and hard to understand.…
-
It would be good to have more documentation on the configuration functions along with an example of how to start the IMAP server. At the moment it is not clear how to use the configuration functions u…
-