From 4948d84b8a6a894f716d605dad8dfa7d12f7d53a Mon Sep 17 00:00:00 2001 From: Stephan Schulz <stephan.schulz-x2q@rub.de> Date: Mon, 25 Jan 2021 16:59:40 +0100 Subject: [PATCH] add libALL to doc --- docs/Examples.rst | 3 ++- docs/Usage.rst | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/Examples.rst b/docs/Examples.rst index 9e325fb..fe7ef3d 100644 --- a/docs/Examples.rst +++ b/docs/Examples.rst @@ -3,7 +3,8 @@ Examples ======== In the ``/examples`` sub directory several C++ and Fortran example -programs are place, as well as example projects. +programs are place, as well as example projects. In some cases, where +`ALL` would be confusing, the library is referred to as `libALL`. Projects -------- diff --git a/docs/Usage.rst b/docs/Usage.rst index 40fbae9..97df603 100644 --- a/docs/Usage.rst +++ b/docs/Usage.rst @@ -6,7 +6,9 @@ Usage The library is presented as a single load balancing object ``ALL::ALL`` from ``ALL.hpp``. All classes are encapsulated in the ``ALL`` name space. Simple (and not so simple) examples are available in the ``/examples`` sub -directory. The simple examples are also documented at length. +directory. The simple examples are also documented at length. In cases +where the name `ALL` is misleading, the library is referred to as +`libALL`. Errors are treated as exceptions that are thrown of a (sub) class of ``ALL::CustomException``. Likely candidates that may throw exceptions are -- GitLab