search

alienscience / imapsrv

An IMAP server written in Go
BSD 3-Clause "New" or "Revised" License
48 stars 9 forks source link

Improve godoc #21

Open alienscience opened 9 years ago

alienscience commented 9 years ago

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 unless you have read the blog post on their use.

The DummyImap server should not be public because it is only used for testing and takes up around 1/3 of the godoc at the moment.

EtienneBruines commented 9 years ago

It should be noted that the correct godoc convention should be used... This currently is not the case, and I think it should be updated with this issue.

The example can consist of demos? Such as the one currently present?