aboutsummaryrefslogtreecommitdiffstats
path: root/fg21sim
diff options
context:
space:
mode:
Diffstat (limited to 'fg21sim')
-rw-r--r--fg21sim/webui/utils.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/fg21sim/webui/utils.py b/fg21sim/webui/utils.py
index b3b013a..bf62525 100644
--- a/fg21sim/webui/utils.py
+++ b/fg21sim/webui/utils.py
@@ -92,7 +92,13 @@ def ip_in_network(ip, network):
ip : `~ipaddress.IPv4Address`, str
An `~ipaddress.IPv4Address` instance or a string of the IPv4 address
network : `~ipaddress.IPv4Network`, str
- An `~ipaddress.IPv4Network` instance or a string of the IPv4 network
+ An `~ipaddress.IPv4Network` instance or a string of the IPv4 network,
+ which is generally written in the CIDR format.
+
+ Raises
+ ------
+ ValueError :
+ Input IP or network is invalid.
"""
if not isinstance(ip, ipaddress.IPv4Address):
ip = ipaddress.IPv4Address(ip)