9 ms·
When I worked on Qt I would monitor various mailinglists and when I would see more than one person asking how to do X I would often go and figure out why the do
by icefox 15y ago
When I worked on Qt I would monitor various mailinglists and when I would see more than one person asking how to do X I would often go and figure out why the documentation didn't provide that answer.
One simple example is that when using QCryptographicHash a common operation is to compare the results to a hex string. QCryptographicHash::result() returned a QByteArray which isn't a hex string. So after seeing more than one person ask how to do this I added a "\seealso QByteArray::toHex()" to the documentation.
http://doc.trolltech.com/4.7/qcryptographichash.html#result http://doc.trolltech.com/4.7/qcryptographichash.html#result
Another favorite thing to do was if people were looking for a function say called "Foo::search", but it was actually called "Foo::query" I would add the word "search" inside of the Foo::query docs so at the bare minimum if they searched on the Foo page they would find the word search and the api they needed. Often after that help for Foo::search disappear. (or to do bla you have to call X() and Y(), mentioning bla in X and Y's docs really help)
There was a lot of pride in the Qt documentation and little improvements like this all of the time really helped to make the dev experience better.