docs

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

Author: jkowalleck

cyclonedx/schema/deprecation.py

@@ -34,6 +34,7 @@
 
 
 class SchemaDeprecationWarning(DeprecationWarning, ABC):
+    """Base class for warnings about deprecated schema features."""
     SCHEMA_VERSION: ClassVar[SchemaVersion]
 
     @classmethod
@@ -47,28 +48,35 @@ def _warn(cls, deprecated: str, instead: Optional[str] = None,
 
 
 class DeprecationWarning1Dot7(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.7"""
     SCHEMA_VERSION = SchemaVersion.V1_7
 
 
 class DeprecationWarning1Dot6(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.6"""
     SCHEMA_VERSION = SchemaVersion.V1_6
 
 
 class DeprecationWarning1Dot5(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.5"""
     SCHEMA_VERSION = SchemaVersion.V1_5
 
 
 class DeprecationWarning1Dot4(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.4"""
     SCHEMA_VERSION = SchemaVersion.V1_4
 
 
 class DeprecationWarning1Dot3(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.3"""
     SCHEMA_VERSION = SchemaVersion.V1_3
 
 
 class DeprecationWarning1Dot2(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.2"""
     _schema_version_enum = SchemaVersion.V1_2
 
 
 class DeprecationWarning1Dot1(SchemaDeprecationWarning):
+    """Class for warnings about deprecated schema features in CycloneDX 1.1"""
     _schema_version_enum = SchemaVersion.V1_1