Skip to content

Commit 23ad19a

Browse files
committed
doc strings
1 parent ed6e147 commit 23ad19a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

FIAT/check_format_variant.py

+7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import re
2+
23
from FIAT.macro import AlfeldSplit, IsoSplit
34

45
# dicts mapping Lagrange variant names to recursivenodes family names
@@ -39,6 +40,12 @@ def check_format_variant(variant, degree):
3940

4041

4142
def parse_lagrange_variant(variant, discontinuous=False, integral=False):
43+
"""Parses variant options for Lagrange elements.
44+
45+
variant may be a single option or comma-separated pair
46+
indicating the dof type (integral, equispaced, spectral, etc)
47+
and the type of splitting to give a macro-element (Alfeld, iso)
48+
"""
4249
if variant is None:
4350
variant = "integral" if integral else "equispaced"
4451
options = variant.replace(" ", "").split(",")

0 commit comments

Comments
 (0)