Skip to content

Commit

Permalink
Mandate that Axis.unit is used for axis tick labels
Browse files Browse the repository at this point in the history
  • Loading branch information
henrikt-ma committed Aug 11, 2020
1 parent 4370791 commit 4077d02
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,16 @@ \subsubsection{Axis Properties}\label{axis-properties}
Properties may be defined for each \lstinline!Plot! axis:
\begin{lstlisting}[language=modelica]
record Axis
Real min "Axis lower bound";
Real max "Axis upper bound";
String unit "Unit of min and max";
Real min "Axis lower bound, in 'unit'";
Real max "Axis upper bound, in 'unit'";
String unit "Unit of axis tick labels";
String label "Axis label";
end Axis;
\end{lstlisting}

When an axis bound isn't provided, the tool computes one automatically.

The Modelica tool is responsible for showing the unit used for values at the
axis tick marks, so the axis \lstinline!label! shall not contain the unit.
The Modelica tool is responsible for showing that values at the axis tick marks are expressed in \lstinline!unit!, so the axis \lstinline!label! shall not contain this information.

If a tool does not recognize the \lstinline!unit!, it is recommended to issue a
warning and treat the \lstinline!unit! as if it was not specified.
Expand Down

0 comments on commit 4077d02

Please sign in to comment.