Add a sentence to the documentation.

git-svn-id: https://svn.dealii.org/trunk@29505 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/include/deal.II/base/convergence_table.h b/deal.II/include/deal.II/base/convergence_table.h
index 7ab30b21da1838420ecfd64bd3455cb655b1631e..a262a6be3b555fff7b48296cb203020fa6164681 100644 (file)
--- a/deal.II/include/deal.II/base/convergence_table.h
+++ b/deal.II/include/deal.II/base/convergence_table.h
@@ -118,7 +118,9 @@ public:
    * This is useful, for example, if we use as reference key the number of
    * degrees of freedom or better, the number of cells.  Assuming that the
    * error is proportional to $ C (1/\sqrt{k})^r $ in 2D, then this method
-   * will produce the rate $r$ as a result.
+   * will produce the rate $r$ as a result. For general dimension, as described
+   * by the last parameter of this function, the formula needs to be
+   * $ C (1/\sqrt[dim]{k})^r $.
    *
    * @note Since this function adds columns to the table after several rows
    * have already been filled, it switches off the auto fill mode of the