]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify documentation of Patterns::Integer. 6852/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 27 Jun 2018 23:06:49 +0000 (17:06 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 27 Jun 2018 23:06:49 +0000 (17:06 -0600)
include/deal.II/base/patterns.h

index 4346f16eff48ec5fa6ef99dee601eab0512e9d03..3ae7db4cd88720f98dc7c01200413f3a6c50b96d 100644 (file)
@@ -202,6 +202,11 @@ namespace Patterns
      * lower bound, then the entire set of integers is implied. The
      * default values are chosen such that no bounds are enforced on
      * parameters.
+     *
+     * Note that the range implied by an object of the current type
+     * is inclusive of both bounds values, i.e., the @p upper_bound is
+     * an allowed value, rather than indicating a half-open value as
+     * is often done in other contexts.
      */
     Integer(const int lower_bound = min_int_value,
             const int upper_bound = max_int_value);

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.