style.txt: slightly better call for documenting

Sometimes we tend to "just" translate the code to human
which doesn't really help; what usually helps is noting
down what the code author intended to implement or fix,
and what was the case for that.
This commit is contained in:
Michael Shigorin 2016-01-10 13:31:38 +03:00
parent 3b3cf4cc93
commit 41d2644ebe

View File

@ -9,7 +9,11 @@
порой могут выясниться непредвиденные последствия;
* документируйте на русском (README) или английском (README.en) языке
то, что написали или изменили.
то, что написали или изменили, если бы сами хотели прочесть описание
сделанного на месте другого человека; в любом случае старайтесь
внятно описывать коммиты, при необходимости также спрашивайте
совета: документация кода порой не менее важна, чем сам код,
и призвана не повторять его, но пояснять намерения и неочевидности.
[float]
=== рекомендации ===