[drupal-docs] [bug] Ambiguity re: how to write header comment blocks

[webchick]

Issue status update for 
http://drupal.org/node/28251
Post a follow up: 
http://drupal.org/project/comments/add/28251

 Project:      Documentation
 Version:      <none>
 Component:    Developer Guide
 Category:     bug reports
 Priority:     minor
 Assigned to:  Anonymous
 Reported by:  webchick
 Updated by:   webchick
-Status:       fixed
+Status:       patch (code needs review)
 Attachment:   http://drupal.org/files/issues/CODING_STANDARDS.html.patch (771 bytes)

Actually that didn't seem to work. http://drupal.org/node/318 still
shows the "old way."


Attached is the patch I used to change the CODING_STANDARDS.html file
in CVS. Could someone with permissions change the handbook page?




webchick



Previous comments:
------------------------------------------------------------------------

Fri, 05 Aug 2005 04:10:24 +0000 : webchick

The coding standards recommend two different methods of inserting header
comment blocks:


- http://drupal.org/node/318 (Coding standards page) recommends: /*
$Id$ */
- http://drupal.org/node/546 (Header comment blocks page) recommends:
// $Id$


I checked the files in core, and it seems that the // $Id$ notation is
more common, so is probably supposed to be the standard followed? If
that's the case, 318 should probably be updated to reflect this since
that appears on the surface at least to be an "all-in-one" document for
coding standards... I would guess that most users don't even hit the
second page. But in either case, it would be nice to know which method
is preferred.




------------------------------------------------------------------------

Fri, 12 Aug 2005 02:35:39 +0000 : webchick

I noticed today that all the files in core are now changed to the //
$Id$ style for consistency, so the fix for this issue would be:


http://drupal.org/node/318


Change:


<?php
/* $Id$ */


to:


<?php
// $Id$


and:


<?php
/* $Id: CODING_STANDARDS.html,v 1.4 2004/10/27 11:55:32 uwe Exp $ */


to:


<?php
// $Id: CODING_STANDARDS.html,v 1.4 2004/10/27 11:55:32 uwe Exp $




------------------------------------------------------------------------

Thu, 08 Sep 2005 14:56:08 +0000 : cel4145

It appears that the particular handbook page in question uses php to
pull the coding standards from a location in Drupal CVS:


http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/CODING_STANDARDS.html


Could someone with CVS access implement this update to the coding
standards text?




------------------------------------------------------------------------

Sun, 11 Sep 2005 14:41:29 +0000 : webchick

Hey cool! Something I can actually do! :D Updated.