From d1647c9fac3556dbab53e5223c795fc3245d681a Mon Sep 17 00:00:00 2001
From: Cory Mikida <cmikida2@illinois.edu>
Date: Fri, 15 May 2020 13:16:20 -0500
Subject: [PATCH] Adds example of new face_to_boundary_tag input to docstring

---
 meshmode/mesh/generation.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/meshmode/mesh/generation.py b/meshmode/mesh/generation.py
index 335751e9..d5153ec6 100644
--- a/meshmode/mesh/generation.py
+++ b/meshmode/mesh/generation.py
@@ -669,7 +669,9 @@ def generate_box_mesh(axis_coords, order=1, coord_dtype=np.float64,
     :param face_to_boundary_tag: an optional dictionary for boundary configuration.
         The keys correspond to custom boundary tags, with the values giving
         a list of the faces on which they should be applied in terms of coordinate
-        directions (+x, -x, +y, -y, +z, -z).
+        directions (+x, -x, +y, -y, +z, -z). One example of this would be:
+
+        face_to_boundary_tag={"bdry_1": ["+x", "+y"], "bdry_2": ["-x"]}
 
     .. versionchanged:: 2017.1
 
-- 
GitLab