Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove invalid docsting note about auto-assigned bom-ref values #733

Merged
merged 1 commit into from
Oct 29, 2024
Merged

docs: remove invalid docsting note about auto-assigned bom-ref values #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions cyclonedx/model/component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1185,8 +1185,6 @@ def bom_ref(self) -> BomRef:
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
unique within the BOM.

If a value was not provided in the constructor, a UUIDv4 will have been assigned.

Returns:
`BomRef`
"""
Expand Down
2 changes: 0 additions & 2 deletions cyclonedx/model/contact.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,6 @@ def bom_ref(self) -> Optional[BomRef]:
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
unique within the BOM.

If a value was not provided in the constructor, a UUIDv4 will have been assigned.

Returns:
`BomRef`
"""
Expand Down
3 changes: 2 additions & 1 deletion cyclonedx/model/definition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ def __repr__(self) -> str:
def bom_ref(self) -> BomRef:
"""
An optional identifier which can be used to reference the standard elsewhere in the BOM. Every bom-ref MUST be
unique within the BOM. If a value was not provided in the constructor, a UUIDv4 will have been assigned.
unique within the BOM.

Returns:
`BomRef`
"""
Expand Down
2 changes: 0 additions & 2 deletions cyclonedx/model/service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ def bom_ref(self) -> BomRef:
An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced
within all elements and children of the root-level bom element.

If a value was not provided in the constructor, a UUIDv4 will have been assigned.

Returns:
`BomRef` unique identifier for this Service
"""
Expand Down
2 changes: 0 additions & 2 deletions cyclonedx/model/vulnerability.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,8 +989,6 @@ def bom_ref(self) -> BomRef:
"""
Get the unique reference for this Vulnerability in this BOM.

If a value was not provided in the constructor, a UUIDv4 will have been assigned.

Returns:
`BomRef`
"""
Expand Down