docs

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

cyclonedx/contrib/bom/utils.py

@@ -30,6 +30,9 @@
 
 
 class BomRefDiscriminator:
+    """
+    Utility to give BomRefs unique values.
+    """
 
     def __init__(self, bomrefs: Iterable['BomRef'], prefix: str = 'BomRef') -> None:
         # do not use dict/set here, different BomRefs with same value have same hash and would shadow each other
@@ -43,6 +46,10 @@ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         self.reset()
 
     def discriminate(self) -> None:
+        """
+        Check BomRefs' values for uniqueness.
+        Duplications will be assigned a unique value.
+        """
         known_values = []
         for bomref, _ in self._bomrefs:
             value = bomref.value
@@ -52,6 +59,9 @@ def discriminate(self) -> None:
             known_values.append(value)
 
     def reset(self) -> None:
+        """
+        Reset BomRef's values to the initial state.
+        """
         for bomref, original_value in self._bomrefs:
             bomref.value = original_value