Closed (fixed)
Project:
Documentation
Component:
Correction/Clarification
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
30 Aug 2005 at 16:02 UTC
Updated:
2 Jun 2009 at 15:30 UTC
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
Comments
Comment #1
sepeck commentedAssigning to myself for follow up on the dev guide.
Comment #2
forngren commentedI 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
Comment #3
forngren commentedSince 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.
Comment #4
jstarbow commentedI'm taking on the project of cleaning up the Coding Standards section. Once node 318 is updating from the cvs (which should be soon, hopefully) I'll clean up the redundant and conflicting sub-pages in the menu.
Comment #5
nielsbom commentedChanged the component to reflect the new component categorization. See http://drupal.org/node/301443
-nielsbom
Comment #6
add1sun commentedUntil yesterday, the coding standards page (http://drupal.org/coding-standards) was only in CVS and only updated on the website once a year or so, which made updates really hard. As a result many subpages/sections have popped up underneath it. Now that we have converted the main page into a regular handbook page (that site admins can edit), we need to:
1) review the new page against the comments and the pending issues in the queue* to see if the issues have already been rolled in/addressed or not. (The CVS version was up-to-date while the old handbook page was from July 2008.)
2) Update the page, if needed, then close out issues and delete comments.
3) Once we have the base information all caught up, figure out the best way to organize this section. What should be on the main page and which should be in subpages? Organize it and then remove duplicate content. Issues related to the organization:
#103512: Coding standards cleanup: icons and coding standards
#103522: Coding standards cleanup: merge 30785 and 318
* Here is a list of current issues regarding CS content that I'm aware of:
#232193: clarify use of "$Id" in coding standards
#293799: A couple of fixes need on coding standards page
#222164: English vs. U.S. English Coding Standard
#148731: Coding standards needs update.
#268601: Single and Double quote usage
#260220: OOP standards
Comment #7
jbrauer commentedThis is another issue that should be considered in the coding standards cleanup #9010: Rhyme to order of _apihooks functions in modules?
Comment #8
MGParisi commentedWould love to put these issues together in one place so that we can read them all and understand what everyone wants. There is so many issues listed with these pages... Im triing my best to mark them, and reference them!
Comment #9
jhodgdonI looked through all of the above comments and the main issue. It appears to me that all of the issues referenced above have been fixed, so I am going to close this issue.
If people still think that coding standards need to be cleaned up, I think the best thing to do would be to file specific issues. Right now, all of the issues referenced above are fixed, and many/most of the sub-pages referenced in links above have been archived or deleted, so anyone reading through the above would have to spend time (as I just did) verifying what had been fixed and what hadn't been fixed.
All of the above specific issues are fixed now, so please start a new issue if there are more problems.