Skip to content

Commit 17f3445

Browse files
committed
typos and docs
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 2cf3dd8 commit 17f3445

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

cyclonedx/model/lifecycle.py

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,19 @@
4343

4444
@serializable.serializable_enum
4545
class LifecyclePhase(str, Enum):
46+
"""
47+
Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema.
48+
49+
.. note::
50+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.3/#type_classification
51+
"""
4652
DESIGN = 'design'
47-
PREBUILD = 'pre-build'
53+
PRE_BUILD = 'pre-build'
4854
BUILD = 'build'
49-
POSTBUILD = 'post-build'
55+
POST_BUILD = 'post-build'
5056
OPERATIONS = 'operations'
5157
DISCOVERY = 'discovery'
52-
DECOMISSION = 'decommission'
58+
DECOMMISSION = 'decommission'
5359

5460

5561
@serializable.serializable_class
@@ -93,6 +99,13 @@ def __repr__(self) -> str:
9399

94100
@serializable.serializable_class
95101
class NamedLifecycle:
102+
"""
103+
Object that defines custom state in the product lifecycle.
104+
105+
.. note::
106+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.5/#metadata_lifecycles
107+
"""
108+
96109
def __init__(self, name: str, *, description: Optional[str] = None) -> None:
97110
self._name = name
98111
self._description = description

0 commit comments

Comments
 (0)