From 70a5a0f0bfc4d586f0fe804dab068fbd7d3556f1 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Tue, 18 Jul 2023 16:48:12 +0200
Subject: [PATCH] document product types
---
gso/products/product_types/__init__.py | 6 ++++++
gso/products/product_types/device.py | 5 +++++
2 files changed, 11 insertions(+)
diff --git a/gso/products/product_types/__init__.py b/gso/products/product_types/__init__.py
index e69de29b..3e541078 100644
--- a/gso/products/product_types/__init__.py
+++ b/gso/products/product_types/__init__.py
@@ -0,0 +1,6 @@
+"""Product types define the different products that are available.
+
+Multiple product blocks may insist on a single product type. In that sense, a product type is a mode general description
+of a product. For example, the product type {class}`Device` must either be a router or a switch, both being separate
+product blocks.
+"""
diff --git a/gso/products/product_types/device.py b/gso/products/product_types/device.py
index e7dc2703..09ad08a7 100644
--- a/gso/products/product_types/device.py
+++ b/gso/products/product_types/device.py
@@ -5,6 +5,11 @@ from gso.products.product_blocks.device import DeviceBlock, DeviceBlockInactive,
class DeviceType(strEnum):
+ """Enumerator for different device types.
+
+ A device can either be a router or a switch.
+ """
+
router = "router"
switch = "switch"
--
GitLab