]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Minor doc update. 11010/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 6 Oct 2020 00:53:18 +0000 (18:53 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 6 Oct 2020 00:53:18 +0000 (18:53 -0600)
include/deal.II/base/convergence_table.h

index 7d95d213bf2d35b66bb0b4a1f5a80283e0d7cd15..3a85cd74ce6b21b42b4f887cabe5facaf7c47d73 100644 (file)
@@ -38,10 +38,11 @@ DEAL_II_NAMESPACE_OPEN
  * set in relation to the number of cells or the number of DoFs. The
  * implementations of these non-standard methods is left to a user.
  *
- * The number of cells may be added to the table by
- * calling e.g.  `add_value("n cells", n_cells)`. The number of DoFs may be
- * added to the table by calling `add_value("n dofs", n_dofs)`. Further table
- * data is also added by calling add_value().  Before the output of the table
+ * For example, the number of cells may be added to the table by
+ * calling `add_value("n cells", n_cells)`. The number of DoFs may be
+ * added to the table by calling `add_value("n dofs", n_dofs)`. Of course,
+ * one can also add more kinds of information by calling
+ * add_value() with other arguments. In any case, before the output of the table
  * the functions evaluate_convergence_rates() and
  * evaluate_all_convergence_rates() may be called.
  *

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.