From 23775c7daf6d941f8d3871839f608d15ef90ff8e Mon Sep 17 00:00:00 2001 From: Han Lu <11597940+ErbB4@users.noreply.github.com> Date: Thu, 1 Aug 2024 12:01:47 +0200 Subject: [PATCH] quick touch and fix typos etc (#2366) <!-- Please make sure your PR follows our [contribution guidelines](https://github.com/arbor-sim/arbor/tree/master/doc/contrib) and agree to the terms outlined in the [PR procedure](https://github.com/arbor-sim/arbor/tree/master/doc/contrib/pr.rst). --> --- doc/dev/debug.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/dev/debug.rst b/doc/dev/debug.rst index a9705c4c..9d862655 100644 --- a/doc/dev/debug.rst +++ b/doc/dev/debug.rst @@ -7,9 +7,9 @@ Backtraces ---------- When building Arbor you can enable backtraces in the CMake configure step by -setting ``ARB_BACKTRACE=ON``. Beware aware that this requires the ``Boost`` +setting ``ARB_BACKTRACE=ON``. Beware that this requires the ``Boost`` libraries to be installed on your system. This will cause the following -additions to Arbor's behaviour +additions to Arbor's behaviour: 1. Failed assertions via ``asb_assert`` will print the corresponding stacktrace. 2. All exceptions deriving from ``arbor_exception`` and ``arbor_internal_error`` @@ -23,7 +23,7 @@ LLDB. .. note:: Since Arbor often uses a buffer of instructions on how to construct a - particular object instead of perform the action right away, errors occur not + particular object instead of performing the action right away, errors occur not always at the location you might expect. Consider this (adapted from ``network_ring.py``) -- GitLab