[FFmpeg-cvslog] r24039 - trunk/doc/developer.texi

stefano subversion
Sun Jul 4 17:40:03 CEST 2010

Author: stefano
Date: Sun Jul  4 17:40:03 2010
New Revision: 24039

Revert commit:
  Author: stefano
  Date: Sat Jul  3 20:19:38 2010
  New Revision: 24023

  State in the guidelines that function and parameter descriptions in
  the doxy must use impersonal verbal form.

  This form is apparently favored by most English speaker developers,
  and has the advantage of being easier to use than the third person

  This should hopefully put an end to the Third Person Holy Bikeshed

The change was neither discussed on the FFmpeg ML, nor approved by the
project leader.

The Holy War will continue soon on FFmpeg-devel, stay tuned ;-).


Modified: trunk/doc/developer.texi
--- trunk/doc/developer.texi	Sun Jul  4 14:43:18 2010	(r24038)
+++ trunk/doc/developer.texi	Sun Jul  4 17:40:03 2010	(r24039)
@@ -83,9 +83,6 @@ format (see examples below) so that code
 can be generated automatically. All nontrivial functions should have a comment
 above them explaining what the function does, even if it is just one sentence.
 All structures and their member variables should be documented, too.
-Impersonal form must be used for the function and parameter
-descriptions, e.g. "Set the bikeshed color." is favored over "Sets the
-bikeshed color.".
  * @@file mpeg.c

More information about the ffmpeg-cvslog mailing list