Skip to content

Commit

Permalink
Clarify displayUnit for %par
Browse files Browse the repository at this point in the history
Closes #2339
  • Loading branch information
HansOlsson committed Jul 5, 2019
1 parent b2a15aa commit ddbaf08
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -822,7 +822,10 @@ \subsubsection{Text}\doublelabel{text}
\begin{itemize}
\item
\%\emph{par} and \%\{\emph{par\}} replaced by the value of the
parameter \emph{par}. The intent is that the text is easily readable,
parameter \emph{par}.
If the value is numeric, tools shall display the value with displayUnit, formatted according to bipm-specification.
E.g., for \lstinline!parameter Real t(unit="s",displayUnit="ms")=0.1! tools shall display \lstinline!100 ms!.
The intent is that the text is easily readable,
thus if par is of an enumeration type, replace \%par by the item name,
not by the full name.\\
\emph{{[}Example: if par="Modelica.Blocks.Types.Enumeration.Periodic",
Expand Down

0 comments on commit ddbaf08

Please sign in to comment.