[documentation] [Documentation bug] Codings standards cleanup

[forngren]

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

 Project:      Documentation
 Version:      <none>
 Component:    Developer Guide
 Category:     bug reports
 Priority:     normal
 Assigned to:  sepeck
 Reported by:  Thomas Ilsche
 Updated by:   forngren
 Status:       active

Since the coding standards is such an important part of at least Drupal
core it's very important to have them correct. We could either have all
parts of it in subpages or all in one page, preferable using anchors. A
first step in either way is to write up the documentation to make it
accurate, and then we can discuss if it should one page or several
subpages.


I have been creating separate issues for the errors I found, labeling
them with "Coding standards cleanup"
http://drupal.org/project/issues?projects=18753&text=Coding%20standards%...


IMO; http://drupal.org/node/1354 and http://drupal.org/node/29325 are
examples how subpages should be used. Not the coding standards itself,
but how to apply them and things like doxygen formatting conventions.


Thank you.




forngren



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

Tue, 30 Aug 2005 16:02:13 +0000 : Thomas Ilsche

I'm new here but I have not found an issue about this.


The Drupal Coding Standards[1] contradict to some authoring guidelines
[2] and most of the child nodes are duplicates of what is already stated
at the parent node. [3] states that php code should be enclosed in <?php
?> while this page uses <code>.
Also a child node has a broken link [4].


All in all this needs general structuring (Inline heading OR Child
nodes).


[1] http://drupal.org/node/318
[2] http://drupal.org/node/24221
[3] http://drupal.org/about/authoring
[4] http://drupal.org/node/543#comment-4846




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

Mon, 27 Mar 2006 20:47:04 +0000 : sepeck

Assigning to myself for follow up on the dev guide.




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

Fri, 15 Dec 2006 20:16:32 +0000 : forngren

I agree, the page contains lot of duplicates. IMO they should be
rewritten into one page to avoid misunderstandings.


The following pages are dupes from http://drupal.org/node/318
http://drupal.org/node/540, Control structures
http://drupal.org/node/5993, Constants


Confusing pages
http://drupal.org/node/539 and main page, indenting
http://drupal.org/node/545 and main page, PHP code tags
http://drupal.org/node/5992 and main page, Functions and methods
http://drupal.org/node/546 and main page, Using CVS


Not on main page
http://drupal.org/node/30785
http://drupal.org/node/30785


Does this belong in coding standards?
http://drupal.org/node/35416