From: Timo Heister Date: Fri, 13 Apr 2018 20:11:02 +0000 (-0400) Subject: documentation fixes for hyper_L X-Git-Tag: v9.0.0-rc1~181^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F6244%2Fhead;p=dealii.git documentation fixes for hyper_L --- diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index df6f2ec078..064ff48464 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -642,10 +642,11 @@ namespace GridGenerator * test convergence of schemes when the solution lacks regularity. * * If the @p colorize flag is set, the @p boundary_ids of the - * surfaces are assigned, such that the left boundary is 0, and the - * others are set with growing number accordingly to the - * counterclockwise. Colorize option works only with 2-dimensional - * problem. This function will create the classical L-shape in 2d + * surfaces are assigned such that the left boundary is 0 and the + * others are assigned counterclockwise in ascending order. + * The @p colorize option only works in two dimensions. + * + * This function will create the classical L-shape in 2d * and it will look like the following in 3d: * * @image html hyper_l.png