From 9c133687a93354f7a39b8bac7eb417812997e84e Mon Sep 17 00:00:00 2001 From: Michael Wetter Date: Tue, 24 Oct 2023 09:41:43 -0700 Subject: [PATCH] Updated documentation of Examples package This adds more information to the top-level documentation of IBPSA.Examples --- IBPSA/Examples/package.mo | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/IBPSA/Examples/package.mo b/IBPSA/Examples/package.mo index e6c1857adb..c71344cfb6 100644 --- a/IBPSA/Examples/package.mo +++ b/IBPSA/Examples/package.mo @@ -3,9 +3,20 @@ package Examples "Collection of models that illustrate model use and test models extends Modelica.Icons.ExamplesPackage; annotation (preferredView="info", Documentation(info="

-This package contains examples for the use of models that can be found in - -IBPSA. +This package contains examples and tutorials with step-by-step instructions +for how to build system models. +

+

+The examples illustrate +the scope of the library. Smaller examples that typically only +use models from a few packages can be found in the individual packages. +For example, see + +Buildings.Airflow.Multizone.Examples for examples of +multizone airflow and contaminant transport models, or + +IBPSA.Fluid.HeatExchangers.Examples for +examples of heat exchanger models.

")); end Examples;