From 8ac8442a7fe2be31850baaf9a955806d2e89cf28 Mon Sep 17 00:00:00 2001
From: Neda Moeini <neda.moeini@geant.org>
Date: Mon, 22 Jul 2024 16:08:43 +0200
Subject: [PATCH] Updated docstr.
---
gso/utils/helpers.py | 13 ++++---------
1 file changed, 4 insertions(+), 9 deletions(-)
diff --git a/gso/utils/helpers.py b/gso/utils/helpers.py
index bbdbdd93..fdf851e8 100644
--- a/gso/utils/helpers.py
+++ b/gso/utils/helpers.py
@@ -311,15 +311,10 @@ def generate_inventory_for_active_routers(
Contains all active routers of a specific role. Optionally, routers can be excluded from the inventory.
- Args:
- ----
- router_role (RouterRole): The role of the routers to include in the inventory.
- exclude_routers (list): List of routers to exclude from the inventory.
-
- Returns:
- -------
- dict[str, Any]: A dictionary representing the inventory of active routers.
-
+ :param RouterRole router_role: The role of the routers to include in the inventory.
+ :param list exclude_routers: List of routers to exclude from the inventory.
+ :return: A dictionary representing the inventory of active routers.
+ :rtype: dict[str, Any]
"""
all_routers = [Router.from_subscription(r["subscription_id"]) for r in get_active_router_subscriptions()]
exclude_routers = exclude_routers or []
--
GitLab