Skip to content

Commit 0d0443d

Browse files
committed
typos
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 9436747 commit 0d0443d

4 files changed

Lines changed: 12 additions & 12 deletions

File tree

cyclonedx/exception/factory.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
.. deprecated:: next
4545
This re-export location is deprecated.
4646
Use ``from cyclonedx.contrib.license.exceptions import FactoryException`` instead.
47-
The exported symbol itself is NOT deprecated - only this import path.
47+
The exported symbol itself is NOT deprecated only this import path.
4848
"""
4949

5050
LicenseChoiceFactoryException = _LicenseChoiceFactoryException
@@ -53,7 +53,7 @@
5353
.. deprecated:: next
5454
This re-export location is deprecated.
5555
Use ``from cyclonedx.contrib.license.exceptions import LicenseChoiceFactoryException`` instead.
56-
The exported symbol itself is NOT deprecated - only this import path.
56+
The exported symbol itself is NOT deprecated only this import path.
5757
"""
5858

5959
InvalidSpdxLicenseException = _InvalidSpdxLicenseException
@@ -62,7 +62,7 @@
6262
.. deprecated:: next
6363
This re-export location is deprecated.
6464
Use ``from cyclonedx.contrib.license.exceptions import InvalidSpdxLicenseException`` instead.
65-
The exported symbol itself is NOT deprecated - only this import path.
65+
The exported symbol itself is NOT deprecated only this import path.
6666
"""
6767

6868
LicenseFactoryException = _LicenseFactoryException
@@ -71,7 +71,7 @@
7171
.. deprecated:: next
7272
This re-export location is deprecated.
7373
Use ``from cyclonedx.contrib.license.exceptions import LicenseFactoryException`` instead.
74-
The exported symbol itself is NOT deprecated - only this import path.
74+
The exported symbol itself is NOT deprecated only this import path.
7575
"""
7676

7777
InvalidLicenseExpressionException = _InvalidLicenseExpressionException
@@ -80,7 +80,7 @@
8080
.. deprecated:: next
8181
This re-export location is deprecated.
8282
Use ``from cyclonedx.contrib.license.exceptions import InvalidLicenseExpressionException`` instead.
83-
The exported symbol itself is NOT deprecated - only this import path.
83+
The exported symbol itself is NOT deprecated only this import path.
8484
"""
8585

8686
# endregion deprecated re-export

cyclonedx/model/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -382,29 +382,29 @@ class HashType:
382382
"""
383383

384384
@staticmethod
385-
@deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alg instead')
385+
@deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory().from_hashlib_alg() instead')
386386
def from_hashlib_alg(hashlib_alg: str, content: str) -> 'HashType':
387387
"""Deprecated — Alias of :func:`cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alg`.
388388
389389
Attempts to convert a hashlib-algorithm to our internal model classes.
390390
391391
.. deprecated:: next
392-
Use ``cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alg()`` instead.
392+
Use ``cyclonedx.contrib.hash.factories.HashTypeFactory().from_hashlib_alg()`` instead.
393393
"""
394394
from ..contrib.hash.factories import HashTypeFactory
395395

396396
return HashTypeFactory().from_hashlib_alg(hashlib_alg, content)
397397

398398
@staticmethod
399-
@deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str instead')
399+
@deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory().from_composite_str() instead')
400400
def from_composite_str(composite_hash: str) -> 'HashType':
401401
"""Deprecated — Alias of :func:`cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str`.
402402
403403
Attempts to convert a string which includes both the Hash Algorithm and Hash Value and represent using our
404404
internal model classes.
405405
406406
.. deprecated:: next
407-
Use ``cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str()`` instead.
407+
Use ``cyclonedx.contrib.hash.factories.HashTypeFactory().from_composite_str()`` instead.
408408
"""
409409
from ..contrib.hash.factories import HashTypeFactory
410410

cyclonedx/model/component.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -959,14 +959,14 @@ class Component(Dependable):
959959
"""
960960

961961
@staticmethod
962-
@deprecated('Deprecated - use cyclonedx.contrib.component.builders.ComponentBuilder.make_for_file instead')
962+
@deprecated('Deprecated - use cyclonedx.contrib.component.builders.ComponentBuilder().make_for_file() instead')
963963
def for_file(absolute_file_path: str, path_for_bom: Optional[str]) -> 'Component':
964964
"""Deprecated — Wrapper of :func:`cyclonedx.contrib.component.builders.ComponentBuilder.make_for_file`.
965965
966966
Helper method to create a Component that represents the provided local file as a Component.
967967
968968
.. deprecated:: next
969-
Use ``cyclonedx.contrib.component.builders.ComponentBuilder.make_for_file()`` instead.
969+
Use ``cyclonedx.contrib.component.builders.ComponentBuilder().make_for_file()`` instead.
970970
"""
971971
from ..contrib.component.builders import ComponentBuilder
972972

cyclonedx/model/license.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class LicenseAcknowledgement(str, Enum):
5959
# In an error, the name of the enum was `LicenseExpressionAcknowledgement`.
6060
# Even though this was changed, there might be some downstream usage of this symbol, so we keep it around ...
6161
LicenseExpressionAcknowledgement = LicenseAcknowledgement
62-
"""Deprecated - Alias for :class:`LicenseAcknowledgement`
62+
"""Deprecated Alias for :class:`LicenseAcknowledgement`
6363
6464
.. deprecated:: next Import `LicenseAcknowledgement` instead.
6565
The exported original symbol itself is NOT deprecated - only this import path.

0 commit comments

Comments
 (0)