Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Feeling is what matters, especially for newbies.. Documentation should be written is a light, non-boring style. Django's or Android's is a best examples.


Django's or Android's is a best examples

Yes, but how can you put those in the same bucket with MySQL's?

http://dev.mysql.com/doc/refman/5.5/en/mysqldump.html vs http://www.postgresql.org/docs/current/static/app-pgdump.htm...

Note how half the page of the mysqldump docs is spent explaining the braindead semantics and dangerous interaction between --opt* and pretty much everything else.

Moreover the MySQL docs generally read as if they were written by a monkey with ADD:

mysqldump can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the --quick option (or --opt, which enables --quick). The --opt option (and hence --quick) is enabled by default, so to enable memory buffering, use --skip-quick.

This is frankly just a random example from recent memory. Compare any two pages and you get similar results.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: