add docstring

giampaolo · Jan 23, 2025 · 37d2f7a · 37d2f7a
1 parent 9143e06
commit 37d2f7a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/psutil/_common.py b/psutil/_common.py
@@ -604,6 +604,9 @@ def conn_to_ntuple(fd, fam, type_, laddr, raddr, status, status_map, pid=None):
 
 
 def broadcast_addr(addr):
+    """Given the address ntuple returned by ``net_if_addrs()``
+    calculates the broadcast address.
+    """
     import ipaddress
 
     if not addr.address or not addr.netmask: