From 7eab0e89c8bbb8629777cd5891f4aff7e41e019e Mon Sep 17 00:00:00 2001 From: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Date: Wed, 13 Nov 2024 13:58:42 -0800 Subject: [PATCH] update docstrings --- nautobot_chatops/integrations/grafana/diffsync/sync.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/nautobot_chatops/integrations/grafana/diffsync/sync.py b/nautobot_chatops/integrations/grafana/diffsync/sync.py index 47518532..c69a7c0b 100644 --- a/nautobot_chatops/integrations/grafana/diffsync/sync.py +++ b/nautobot_chatops/integrations/grafana/diffsync/sync.py @@ -27,6 +27,9 @@ def run_dashboard_sync(overwrite: bool = False) -> Union[str, None]: Args: overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana. + + Raises: + ImportError: If DiffSync is not installed. """ if not DIFFSYNC_INSTALLED: raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.") @@ -60,6 +63,9 @@ def run_panels_sync(dashboard: Dashboard, overwrite: bool = False) -> Union[str, Args: dashboard (nautobot_chatops.integrations.grafana.models.Dashboard): The dashboard we are going to do a diffsync with. overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana. + + Raises: + ImportError: If DiffSync is not installed. """ if not DIFFSYNC_INSTALLED: raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.") @@ -93,6 +99,9 @@ def run_variables_sync(dashboard: Dashboard, overwrite: bool = False) -> Union[s Args: dashboard (nautobot_chatops.integrations.grafana.models.Dashboard): The dashboard we are going to do a diffsync with. overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana. + + Raises: + ImportError: If DiffSync is not installed. """ if not DIFFSYNC_INSTALLED: raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.")