Ticket #2924: doc-2924.patch

prog/prog.tex

@@ -114 +114 @@
 mentioned in this chapter.
 
 \section{Coding Conventions}
-Follow the standard Python formatting rules when writing code for SciPy,
+Follow the standard Python formatting rules when writing code for Sage,
 as explained at \url{http://www.python.org/doc/essays/styleguide.html}. 
 In particular, 
 \begin{itemize}
@@ -124 +124 @@
   editors will automatically search/replace leading tabs with 4
   spaces.
 
-\item Use all lowercase function/class names with underscore separated words:
+\item Usually use all lowercase function names with words separated by underscores:
 \begin{verbatim}
         def set_some_value()
 \end{verbatim}
      instead of:
 \begin{verbatim}
-        def setSomeValue()
+        def SetSomeValue()
 \end{verbatim}
-There is no differentiation between classes, functions, verbs,
-nouns, etc.  
+\item Use CamelCase for class names and major functions that create
+    objects, e.g., \code{PolynomialRing}. 
 \end{itemize}