Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenning committed Nov 17, 2023
1 parent 98c21f5 commit 6f0a294
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ciscoconfparse/ciscoconfparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 6f0a294

Please sign in to comment.