Skip to content

Commit f351a2d

Browse files
committed
docs: migrate to v8.0.0
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 1006a99 commit f351a2d

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,4 @@ If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-o
4747
contributing
4848
support
4949
changelog
50+
upgrading

docs/upgrading.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ to keep track of used libraries during the build process.
2222
bom = Bom()
2323
bom.metadata.tools.components.add(cdx_lib_component())
2424
25-
Import model `Tool`
26-
-------------------
25+
Import model Tool
26+
-----------------
2727

2828
Class `cyclonedx.model.Tool` was moved to :class:`cyclonedx.model.tool.Tool`.
2929
Therefore, the imports need to be altered:
@@ -35,7 +35,7 @@ New: ``from cyclonedx.model.tool import Tool``
3535
Altering Metadata Tools
3636
-----------------------
3737

38-
:prop:`cyclonedx.mode.bom.BomMetaData.tool` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
38+
Property :attr:`cyclonedx.model.bom.BomMetaData.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
3939
Therefore, the process of adding new tools was changed.
4040

4141
Old: ``my_bom.metadata.tools.add(my_tool)``
@@ -45,13 +45,16 @@ New: ``my_bom.metadata.tools.tools.add(my_tool)``
4545
Altering Metadata Tools
4646
-----------------------
4747

48-
:prop:`cyclonedx.mode.vulnerability.Vulnerability.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
48+
Property :attr:`cyclonedx.model.vulnerability.Vulnerability.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
4949
Therefore, the process of adding new tools was changed.
5050

5151
Old: ``my_vulnerability.tools.add(my_tool)``
5252

5353
New: ``my_vulnerability.tools.tools.add(my_tool)``
5454

55+
Setting LicenseExpression Acknowledgement
56+
-----------------------------------------
57+
5558
:class:`cyclonedx.model.license.LicenseExpression()` no longer accepts optional arguments in a positional way, but in a key-word way.
5659

5760
Old: ``LicenseExpression(my_exp, my_acknowledgement)``

0 commit comments

Comments
 (0)