Mercurial > octave-nkf
changeset 8203:a9da991c77aa
update contrib.txi
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 08 Oct 2008 14:29:51 -0400 |
| parents | cf59d542f33e |
| children | 963f94ba4e2a |
| files | doc/interpreter/contrib.txi |
| diffstat | 1 files changed, 4 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/contrib.txi Wed Oct 08 20:00:25 2008 +0200 +++ b/doc/interpreter/contrib.txi Wed Oct 08 14:29:51 2008 -0400 @@ -145,8 +145,10 @@ @end example @noindent -The ChangeLog entries should describe what is changed, not why. The reason of -the change should appear in the commit message. +The ChangeLog entries should describe what is changed, not why. Any +explanation of why a change is needed should appear as comments in the +code, particularly if there is something in the code that might not be +obvious to someone reading the code later. The preferred comment mark for places that may need further attention is FIXME.