Today I added a huge amount of code examples to the tinymail API reference documentation and fixed its Python bindings.
It would be nice if some native English speakers could point me to spelling fixes and/or make suggestions for the documentation. What is missing? What documentation do you people need more than what is available now? How can I improve it?
An overview of the available documentation:
- The API reference documentation which (now) includes (a lot) code samples;
- A few standalone tests that can probably also function as code samples;
- The development pages contain a lot interesting pages. Like pages with information about memory usage, library sizes, to do items and a listing of unfinished features, a listing of implemented features, class diagrams (they are already outdated after a week, but I’ll fix that soon), development tips, gdb debugging tips, refdbg reference counting debugging tips, how to implement a type and a unit test and how to inherit an existing type, how to perform memory testing, detailed per platform building information and finally documentation about how to write documentation for tinymail.
Yet I still feel like something critical is missing. From the webstats I noticed people are also looking a lot at the source code of tinymail. That, by itself, is definitely good. However, is that because it lacks documentation? Please do tell me. Please do express your criticism. I want to know it. The target is, indeed, to implement the project better than perfect.