From: Graham Harper <grahambenharper@gmail.com>
Date: Thu, 30 Jan 2020 03:25:43 +0000 (-0700)
Subject: Update GridGenerator::half_hyper_shell documentation for correctness
X-Git-Tag: v9.2.0-rc1~591^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1f678cea216c37733e52c2a326f4222522870519;p=dealii.git

Update GridGenerator::half_hyper_shell documentation for correctness
---

diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h
index 21b0cd4087..e1501fa74a 100644
--- a/include/deal.II/grid/grid_generator.h
+++ b/include/deal.II/grid/grid_generator.h
@@ -1126,7 +1126,9 @@ namespace GridGenerator
    *
    * If colorize is set to <code>true</code>, the inner, outer, and the part
    * of the boundary where $x=0$, get indicator 0, 1, and 2,
-   * respectively. Otherwise all indicators are set to 0 (see
+   * respectively. Additionally, in 2d, the boundary indicator 3 is given to
+   * the vertical edge below the x-axis. Otherwise, if colorize is set to
+   * <code>false</code> all indicators are set to 0 (see
    * @ref GlossColorization "the glossary entry on colorization").
    *
    * All manifold ids are set to zero, and a SphericalManifold is attached