Skip to content
Snippets Groups Projects
Commit 70a5a0f0 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

document product types

parent 5a8e3936
No related branches found
No related tags found
1 merge request!54Feature/documentation
Pipeline #83789 passed
This commit is part of merge request !54. Comments created here will be created in the context of that merge request.
"""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.
"""
...@@ -5,6 +5,11 @@ from gso.products.product_blocks.device import DeviceBlock, DeviceBlockInactive, ...@@ -5,6 +5,11 @@ from gso.products.product_blocks.device import DeviceBlock, DeviceBlockInactive,
class DeviceType(strEnum): class DeviceType(strEnum):
"""Enumerator for different device types.
A device can either be a router or a switch.
"""
router = "router" router = "router"
switch = "switch" switch = "switch"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment