Suggestions for parameters, routine and filename notation

git-svn-id: http://svn.cactuscode.org/flesh/trunk@603 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index a22221d0..aa0687b6 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -551,6 +551,7 @@ names ? }
 
 {\bf FIXME: talk about before/after. }
 
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -921,6 +922,23 @@ int MyReductionOperator(cGH *GH, int proc, int retvaltype, int numretval, void *
         being returned in the array {\t retvals}.
 \end{itemize}
 
+\section{General Naming Conventions}
+
+The following naming conventions are followed by the flesh and the
+supported Cactus packages. They are not compulsory, but if followed
+allow for a homogeneous code.
+
+\begin{itemize}
+
+\item Parameters: lower case (except for acronyms) with words separated
+  by an underscore. Examples: {\tt my\_first\_parameter}, 
+  {\tt solve\_PDE\_equation}.
+
+\item Filenames and routine names: Prefixed by thorn name with an underscore, then capitalised words, with no spaces.
+    Examples: {\tt MyThorn\_StartUpRoutine}, {\tt BestSolver\_InitialDataForPDE}.
+
+\end{itemize}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%