[PATCH 5 of 6] gendoc: dedent documentation from docstrings
Martin Geisler
mg at aragost.com
Tue Oct 19 02:38:15 CDT 2010
Erik Zielke <ez at aragost.com> writes:
> # HG changeset patch
> # User Erik Zielke <ez at aragost.com>
> # Date 1287406349 -7200
> # Node ID bc4f8b25cbbf1de33ba54dec5e662411086e9489
> # Parent b0e7b4e632aa861d09b18f23a4b1d6860904879b
> gendoc: dedent documentation from docstrings
What is the idea behind this, what is the consequence?
As a general hint, try to make commit messages that does not just
describe *what* is changing but instead describe *why* it is changing.
We can hopefully see the *what* part in the diff. The *why* part is
harder... and you'll appreciate this later when you look at a three year
old changeset and ask yourself "why did the guy make this change?" :)
--
Martin Geisler
aragost Trifork
Professional Mercurial support
http://aragost.com/mercurial/
More information about the Mercurial-devel
mailing list