diff --git a/ciscoconfparse/ciscoconfparse.py b/ciscoconfparse/ciscoconfparse.py index 8775bd1..06ae968 100644 --- a/ciscoconfparse/ciscoconfparse.py +++ b/ciscoconfparse/ciscoconfparse.py @@ -3305,10 +3305,12 @@ def re_match_iter_typed( Notes ----- + Only the first regex match is returned. Parameters ---------- + regex : str A string or python compiled regular expression, which should be matched. This regular expression should contain parenthesis, which bound a match group. group : int @@ -3322,12 +3324,14 @@ def re_match_iter_typed( Returns ------- + ``result_type`` The text matched by the regular expression group; if there is no match, ``default`` is returned. All values are cast as ``result_type``. The default result_type is `str`. Examples -------- + This example illustrates how you can use :func:`~ciscoconfparse.re_match_iter_typed` to get the first interface name listed in the config.