From 41d2644ebeb2ffe6a6cb2b445be5f2dc24786f71 Mon Sep 17 00:00:00 2001 From: Michael Shigorin Date: Sun, 10 Jan 2016 13:31:38 +0300 Subject: [PATCH] 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. --- doc/style.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/style.txt b/doc/style.txt index 38f37ab0..933cff70 100644 --- a/doc/style.txt +++ b/doc/style.txt @@ -9,7 +9,11 @@ порой могут выясниться непредвиденные последствия; * документируйте на русском (README) или английском (README.en) языке - то, что написали или изменили. + то, что написали или изменили, если бы сами хотели прочесть описание + сделанного на месте другого человека; в любом случае старайтесь + внятно описывать коммиты, при необходимости также спрашивайте + совета: документация кода порой не менее важна, чем сам код, + и призвана не повторять его, но пояснять намерения и неочевидности. [float] === рекомендации ===