[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] Rethread "however, one line to describe change ok" idea.
From: |
Thien-Thi Nguyen |
Subject: |
[PATCH] Rethread "however, one line to describe change ok" idea. |
Date: |
Wed, 17 Feb 2010 03:12:23 +0100 |
Here is a suitable ChangeLog entry:
2010-02-17 Thien-Thi Nguyen <address@hidden> (tiny change)
Rethread "however, one line to describe change ok" idea.
* doc/standards.texi (Change Log Concepts):
Move the "however, one line to describe change ok" from its
own paragraph (following another "however..." sentence, thus
losing the antecedent) into the paragraph where "need to
describe full purpose of changes" is first discouraged.
Also, expand the prepositional noun phrase to cover a
single change.
diff --git a/doc/standards.texi b/doc/standards.texi
index 26e30a3..53b5c63 100644
*** a/doc/standards.texi
--- b/doc/standards.texi
***************
*** 3540,3546 ****
@kbd{C-x v a} (@code{vc-update-change-log}) does the job.
There's no need to describe the full purpose of the changes or how they
! work together. If you think that a change calls for explanation, you're
probably right. Please do explain it---but please put the explanation
in comments in the code, where people will see it whenever they see the
code. For example, ``New function'' is enough for the change log when
--- 3540,3549 ----
@kbd{C-x v a} (@code{vc-update-change-log}) does the job.
There's no need to describe the full purpose of the changes or how they
! work together.
! However, sometimes it is useful to write one line to describe the
! overall purpose of a change or a batch of changes.
! If you think that a change calls for explanation, you're
probably right. Please do explain it---but please put the explanation
in comments in the code, where people will see it whenever they see the
code. For example, ``New function'' is enough for the change log when
***************
*** 3552,3560 ****
advised that it is a good idea to include them, for the sake of
copyright records.
- However, sometimes it is useful to write one line to describe the
- overall purpose of a batch of changes.
-
The easiest way to add an entry to @file{ChangeLog} is with the Emacs
command @kbd{M-x add-change-log-entry}. An entry should have an
asterisk, the name of the changed file, and then in parentheses the name
--- 3555,3560 ----
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH] Rethread "however, one line to describe change ok" idea.,
Thien-Thi Nguyen <=