diff --git a/docs/user_guide/basic_usage.md b/docs/user_guide/basic_usage.md index 157bb02d..82334d5e 100644 --- a/docs/user_guide/basic_usage.md +++ b/docs/user_guide/basic_usage.md @@ -269,7 +269,7 @@ scrapli supports parsing output with TextFSM and ntc-templates. This of course r `textfsm_parse_output` method of the response object. This method will attempt to find the template for you -- based on the textfsm-platform and the channel-input (the command sent). If textfsm parsing succeeds, the structured result is returned. If textfsm parsing fails, an empty list is returned. The `textfsm_parse_output` method - also accepts the `raise_err` field to allow parsing exceptions to be handled by the caller. + also accepts an optional `raise_err` argument to allow parsing exceptions to be handled by the caller. ```python from scrapli.driver.core import IOSXEDriver diff --git a/scrapli/response.py b/scrapli/response.py index 693db0a7..5af01646 100644 --- a/scrapli/response.py +++ b/scrapli/response.py @@ -157,6 +157,7 @@ def textfsm_parse_output( to_dict: convert textfsm output from list of lists to list of dicts -- basically create dict from header and row data so it is easier to read/parse the output raise_err: exceptions in the textfsm parser will raised for the caller to handle + Returns: structured_result: empty list or parsed data from textfsm