Skip to content

Commit

Permalink
Merge pull request #5911 from drwells/no-span-dealii
Browse files Browse the repository at this point in the history
Consistently format 'deal.II' in the manual.
  • Loading branch information
MFraters authored Jun 16, 2024
2 parents adb0b58 + 486cc6f commit cfd52ff
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 10 deletions.
3 changes: 1 addition & 2 deletions doc/sphinx/user/extending/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@ which there is an extensive amount of documentation:
<https://github.com/dealii/dealii/wiki/Frequently-Asked-Questions> that
also have extensive sections on developing code with
deal.II as well as on debugging. It also answers
a number of questions we frequently get about the use of C++ in <span
deal.II.
a number of questions we frequently get about the use of C++ in deal.II.

- Several other parts of the deal.II website
at <https://www.dealii.org/> also have information that may be relevant if
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The workflow described previously does not include advice on how to modify
ASPECT inside the container. We recommend a slightly
different workflow for advanced users that want to modify parts of
ASPECT. The ASPECT
docker container itself is built on top of a <span
class="smallcaps">deal.II</span> container that contains all dependencies for
docker container itself is built on top of a deal.II
container that contains all dependencies for
compiling ASPECT. Therefore it is possible to
run the deal.II container, mount an ASPECT
source directory from your host system and compile it inside of the container.
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx/user/install/local-installation/using-candi.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

# Using candi to compile dependencies

In its default configuration `candi` downloads and compiles a <span
class="smallcaps">deal.II</span> configuration that is able to run
In its default configuration `candi` downloads and compiles a
deal.II configuration that is able to run
ASPECT, but it also contains a number of packages
that are not required. We strive to keep
the development version of ASPECT compatible
Expand Down
6 changes: 2 additions & 4 deletions doc/sphinx/user/run-aspect/debug-mode.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
(sec:run-aspect:debug-mode)=
# Debug or optimized mode

ASPECT utilizes a <span
class="smallcaps">deal.II</span> feature called *debug mode*. By default,
ASPECT utilizes a deal.II feature called *debug mode*. By default,
ASPECT is configured in debug mode, i.e., it calls a
version of the deal.II library that contains
lots of checks for the correctness of function arguments, the consistency of
Expand All @@ -11,8 +10,7 @@ many similar consistency checks enabled only in debug mode. Finally,
you can only expect a good debugging experience (for example using *gdb*)
because we only enable debug symbols in *debug mode* (at least by default).

If you program with <span
class="smallcaps">deal.II</span>, for example to extend
If you program deal.II, for example to extend
ASPECT, it has been our experience over the years
that, by number, most programming errors are of the kind where one forgets to
initialize a vector, one accesses data that has not been updated, one tries to
Expand Down

0 comments on commit cfd52ff

Please sign in to comment.