Ignore:
Timestamp:
2019-07-18T16:27:43+02:00 (22 months ago)
Author:
nicolasmartin
Message:

Review of the coding rules chapter: convert it to a shared file for 3 manuals

  • Move annex_D.tex and NEMO_coding_conv.tex to ./latex/global
  • Rename NEMO_coding_conv.tex to coding_rules.tex and redesign it as a chapter and not a standalone document
  • Edit document.tex to include the coding rules by default at the end of the appendix
File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/NEMO/subfiles/introduction.tex

    r11123 r11299  
    151151The coding rules for OPA include conventions for naming variables, 
    152152with different starting letters for different types of variables (real, integer, parameter\ldots). 
    153 Those rules are briefly presented in \autoref{apdx:D} and a more complete document is available . 
     153Those rules are briefly presented in \autoref{apdx:coding} and a more complete document is available . 
    154154 
    155155The model is organized with a high internal modularity based on physics. 
     
    158158To make it easier for the user to find his way around the code, the module names follow a three-letter rule. 
    159159For example, \mdl{traldf} is a module related to the TRAcers equation, computing the Lateral DiFfussion. 
    160 %The complete list of module names is presented in \autoref{apdx:D}.      %====>>>> to be done ! 
     160%The complete list of module names is presented in \autoref{apdx:coding}.      %====>>>> to be done ! 
    161161Furthermore, modules are organized in a few directories that correspond to their category, 
    162162as indicated by the first three letters of their name (\autoref{tab:chapters}). 
Note: See TracChangeset for help on using the changeset viewer.