stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'doc_naming' into 'master' 

Manual: clarify potential naming issues in steady state files

See merge request Dynare/dynare!2007
trustregion
Sébastien Villemot 2022-03-15 16:43:22 +00:00
parent 3a039a1d7f ecbfb7d083
commit 8a6ea14402
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/manual/source/the-model-file.rst
View File

@ -112,10 +112,9 @@ parameters must not have the same name as Dynare commands or built-in
functions. In this respect, Dynare is not case-sensitive. For example, functions. In this respect, Dynare is not case-sensitive. For example,
do not use ``Ln`` or ``Sigma_e`` to name your variable. Not conforming do not use ``Ln`` or ``Sigma_e`` to name your variable. Not conforming
to this rule might yield hard-to-debug error messages or to this rule might yield hard-to-debug error messages or
crashes. Second, to minimize interference with MATLAB or Octave crashes. Second, when employing user-defined steady state files it is
functions that may be called by Dynare or user-defined steady state recommended to avoid using the name of MATLAB functions as this may cause
files, it is recommended to avoid using the name of MATLAB conflicts. In particular, when working with user-defined steady state files, do not
functions. In particular when working with steady state files, do not
use correctly-spelled greek names like `alpha`, because there are use correctly-spelled greek names like `alpha`, because there are
MATLAB functions of the same name. Rather go for ``alppha`` or MATLAB functions of the same name. Rather go for ``alppha`` or
``alph``. Lastly, please do not name a variable or parameter ``alph``. Lastly, please do not name a variable or parameter