Differences

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

--- doc:howto:styleguide [2011/07/10 22:37] – linked to Fedora Style Guide as ours philip
+++ doc:howto:styleguide [2011/07/10 22:42] – added a "common mistakes" section philip
@@ Line 21: / Line 21: @@
   * Examples should use the [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]]
+=== 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