doc:howto:styleguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
doc:howto:styleguide [2011/07/10 22:32] – added PEAR CS philipdoc:howto:styleguide [2011/07/10 22:42] – added a "common mistakes" section philip
Line 6: Line 6:
  
   * A first-person active voice is preferred, which also means do not address the reader directly as "You"   * A first-person active voice is preferred, which also means do not address the reader directly as "You"
 +  * We follow the [[http://fedoraproject.org/wiki/DocsProject/StyleGuide|Fedora Style Guide]]
  
 === Conventions specific to the PHP Manual === === Conventions specific to the PHP Manual ===
Line 21: Line 22:
  
  
 +=== Common mistakes ===
 +  * Improper spacing. Mixing tabs with spaces, and indenting
 +  * Long lines. Line width should not exceed 80 characters, although this is a loose requirement. 100 is probably fine, depending on the situation
 +  * Committing leftover/bogus text that was generated using scripts/docgen/docgen.php. This should not be committed
 +  * Windows line endings. Only use Unix line endings
 +  * Having an IDE or Text editor remove trailing whitespace, then mixing it with commits. Don't do this
 +  * Mixing %%&example.outputs.similar;%% and %%&example.outputs;%% entities. Use the former when the example output may differ, depending on the users usage/settings  
  
doc/howto/styleguide.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1