Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorporate suggestions from #2578 #2579

Merged
merged 5 commits into from
Aug 10, 2020
Merged

Incorporate suggestions from #2578 #2579

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf43dbc
Incorporate suggestions from #2578
otronarp Jun 12, 2020
1b616ec
Clarify that it's an error if cref does not designate a scalar variable
otronarp Aug 10, 2020
dd07ae8
Clarify the behavior for unknown and incompatible units
otronarp Aug 10, 2020
d08f887
Merge branch 'MCP/0033' into MCP/0033-issue-2578
otronarp Aug 10, 2020
41a06eb
Fix broken merge
otronarp Aug 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions chapters/annotations.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ \subsubsection{Plot Curves}\doublelabel{plot-curves}
\end{lstlisting}

The mandatory \lstinline!x! and \lstinline!y! expressions are restricted to be
component references refering to a scalar variable or \lstinline!time!.
component references refering to a scalar variable or \lstinline!time!. If
\lstinline!x! or \lstinline!y! does not designate a variable the behavior is
unspecified.
otronarp marked this conversation as resolved.
Show resolved Hide resolved
otronarp marked this conversation as resolved.
Show resolved Hide resolved
otronarp marked this conversation as resolved.
Show resolved Hide resolved

When \lstinline!legend! isn't provided, the tool produces a default based on
\lstinline!x! and/or \lstinline!y!. Providing the empty string as
Expand All @@ -187,8 +189,11 @@ \subsubsection{Axis Properties}\doublelabel{axis-properties}
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 be used to convey this
information.
axis tick marks, so the axis \lstinline!label! shall not contain the unit.

If the specified unit is not supported by the tool, or the unit does not
represent a display unit of the plotted variable (for example,
\lstinline!unit="cm"! and variable denotes a mass), the behavior is unspecified.
henrikt-ma marked this conversation as resolved.
Show resolved Hide resolved

When an axis label isn't provided, the tool produces a default label. Providing
the empty string as axis label means that no label should be shown. Variable
Expand Down