Skip to content

Commit 6460b71

Browse files
authored
docs: docstrings for schema version classes (#946)
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 44f1273 commit 6460b71

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

cyclonedx/schema/schema.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
from . import SchemaVersion
2424

2525

26-
class BaseSchemaVersion(ABC, ViewType):
27-
26+
class BaseSchemaVersion(ViewType, ABC):
27+
"""Base class for schema version views."""
2828
@property
2929
@abstractmethod
3030
def schema_version_enum(self) -> SchemaVersion:
@@ -35,56 +35,56 @@ def get_schema_version(self) -> str:
3535

3636

3737
class SchemaVersion1Dot7(BaseSchemaVersion):
38-
38+
"""Schema version views 1.7"""
3939
@property
4040
def schema_version_enum(self) -> Literal[SchemaVersion.V1_7]:
4141
return SchemaVersion.V1_7
4242

4343

4444
class SchemaVersion1Dot6(BaseSchemaVersion):
45-
45+
"""Schema version views 1.6"""
4646
@property
4747
def schema_version_enum(self) -> Literal[SchemaVersion.V1_6]:
4848
return SchemaVersion.V1_6
4949

5050

5151
class SchemaVersion1Dot5(BaseSchemaVersion):
52-
52+
"""Schema version views 1.5"""
5353
@property
5454
def schema_version_enum(self) -> Literal[SchemaVersion.V1_5]:
5555
return SchemaVersion.V1_5
5656

5757

5858
class SchemaVersion1Dot4(BaseSchemaVersion):
59-
59+
"""Schema version views 1.4"""
6060
@property
6161
def schema_version_enum(self) -> Literal[SchemaVersion.V1_4]:
6262
return SchemaVersion.V1_4
6363

6464

6565
class SchemaVersion1Dot3(BaseSchemaVersion):
66-
66+
"""Schema version views 1.3"""
6767
@property
6868
def schema_version_enum(self) -> Literal[SchemaVersion.V1_3]:
6969
return SchemaVersion.V1_3
7070

7171

7272
class SchemaVersion1Dot2(BaseSchemaVersion):
73-
73+
"""Schema version views 1.2"""
7474
@property
7575
def schema_version_enum(self) -> Literal[SchemaVersion.V1_2]:
7676
return SchemaVersion.V1_2
7777

7878

7979
class SchemaVersion1Dot1(BaseSchemaVersion):
80-
80+
"""Schema version views 1.1"""
8181
@property
8282
def schema_version_enum(self) -> Literal[SchemaVersion.V1_1]:
8383
return SchemaVersion.V1_1
8484

8585

8686
class SchemaVersion1Dot0(BaseSchemaVersion):
87-
87+
"""Schema version views 1.0"""
8888
@property
8989
def schema_version_enum(self) -> Literal[SchemaVersion.V1_0]:
9090
return SchemaVersion.V1_0

0 commit comments

Comments
 (0)