Ticket #2924: doc-2924.patch

File doc-2924.patch, 1.4 KB (added by was, 13 years ago)
  • prog/prog.tex

    # HG changeset patch
    # User William Stein <wstein@gmail.com>
    # Date 1208217549 25200
    # Node ID cb145bf81d00d1c1d5c08b7f0bd6245066d78fe1
    # Parent  5f6a72b73b412779b2e13174bce7895fbb84620a
    trac #2924 -- programming guide section on style is terrible! (very easy to fix)
    
    diff -r 5f6a72b73b41 -r cb145bf81d00 prog/prog.tex
    a b mentioned in this chapter. 
    114114mentioned in this chapter.
    115115
    116116\section{Coding Conventions}
    117 Follow the standard Python formatting rules when writing code for SciPy,
     117Follow the standard Python formatting rules when writing code for Sage,
    118118as explained at \url{http://www.python.org/doc/essays/styleguide.html}.
    119119In particular,
    120120\begin{itemize}
    In particular, 
    124124  editors will automatically search/replace leading tabs with 4
    125125  spaces.
    126126
    127 \item Use all lowercase function/class names with underscore separated words:
     127\item Usually use all lowercase function names with words separated by underscores:
    128128\begin{verbatim}
    129129        def set_some_value()
    130130\end{verbatim}
    131131     instead of:
    132132\begin{verbatim}
    133         def setSomeValue()
     133        def SetSomeValue()
    134134\end{verbatim}
    135 There is no differentiation between classes, functions, verbs,
    136 nouns, etc.
     135\item Use CamelCase for class names and major functions that create
     136    objects, e.g., \code{PolynomialRing}.
    137137\end{itemize}
    138138
    139139