[Checkins] SVN: Sandbox/ulif/grok-reference-with-rest3/doc/ Add naming conventions into docs.

[Uli Fouquet]

Log message for revision 84193:
  Add naming conventions into docs.

Changed:
  U   Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
  A   Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.rst
  D   Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.txt

-=-
Modified: Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 16:34:19 UTC (rev 84192)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 16:38:31 UTC (rev 84193)
@@ -22,7 +22,10 @@
       <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">The Grok Reference</a><br>
          <span class="linkdescr">describes syntax and package elements</span></p>
 
+      <p class="biglink"><a class="biglink" href="{{ pathto("naming_conventions") }}">Naming Conventions</a><br>
+         <span class="linkdescr">how to name your stuff correctly</span></p>
 
+
     </td></tr>
   </table>
   <p><strong>Indices and tables:</strong></p>

Copied: Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.rst (from rev 84098, Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.txt)
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.rst	                        (rev 0)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.rst	2008-02-23 16:38:31 UTC (rev 84193)
@@ -0,0 +1,33 @@
+Grok naming conventions
+-----------------------
+
+Zope 3 used to follow PEP 8, but then PEP 8 changed so that
+methodNames() is deprecated in favor of method_names().
+
+Grok aims to be mostly consistent with Zope 3, but does make some
+changes in the direction of PEP 8.
+
+modulenames - module and package names are all lower case, no
+underscores
+              
+ClassNames - CamelCase (Zope 3 + PEP 8)
+
+methodNames - camelCase: follow Zope 3 conventions. We work a lot with Zope 3
+              classes and sometimes subclass.
+
+attribute_names - Zope 3 + PEP 8
+
+class_annotations - we break with Zope 3 tradition
+                    (grok.local_utility() versus implementsOnly()). 
+                    This makes class annotations stand out a bit
+                    more and is more consistent with the use of
+                    class-level attribute names for customization
+                    as well (as in formlib).
+
+top_level_functions - Zope 3 uses camel case (getUtility()).  Grok
+                      uses underscores for top-level functions that
+                      define class annotations. Grok internally has also
+                      been using underscores for functions defined
+                      internally. So far we have avoided exposing them
+                      to the outside world. If you need to expose
+                      one of these, bring it up on the grok-dev mailing list.

Deleted: Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.txt
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.txt	2008-02-23 16:34:19 UTC (rev 84192)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/naming_conventions.txt	2008-02-23 16:38:31 UTC (rev 84193)
@@ -1,33 +0,0 @@
-Grok naming conventions
------------------------
-
-Zope 3 used to follow PEP 8, but then PEP 8 changed so that
-methodNames() is deprecated in favor of method_names().
-
-Grok aims to be mostly consistent with Zope 3, but does make some
-changes in the direction of PEP 8.
-
-modulenames - module and package names are all lower case, no
-underscores
-              
-ClassNames - CamelCase (Zope 3 + PEP 8)
-
-methodNames - camelCase: follow Zope 3 conventions. We work a lot with Zope 3
-              classes and sometimes subclass.
-
-attribute_names - Zope 3 + PEP 8
-
-class_annotations - we break with Zope 3 tradition
-                    (grok.local_utility() versus implementsOnly()). 
-                    This makes class annotations stand out a bit
-                    more and is more consistent with the use of
-                    class-level attribute names for customization
-                    as well (as in formlib).
-
-top_level_functions - Zope 3 uses camel case (getUtility()).  Grok
-                      uses underscores for top-level functions that
-                      define class annotations. Grok internally has also
-                      been using underscores for functions defined
-                      internally. So far we have avoided exposing them
-                      to the outside world. If you need to expose
-                      one of these, bring it up on the grok-dev mailing list.