Skip to content

Commit 4fa8fc1

Browse files
authored
docs: fix some doc strings
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent fe979b7 commit 4fa8fc1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

cyclonedx/validation/__init__.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ def validate_str(self, data: str) -> Optional[ValidationError]:
5353
5454
:param data: the data string to validate
5555
:return: validation error
56-
:retval None: if `data` is valid
57-
:retval ValidationError: if `data` is invalid
56+
:retval None: if ``data`` is valid
57+
:retval ValidationError: if ``data`` is invalid
5858
"""
5959
...
6060

@@ -69,19 +69,19 @@ def __init__(self, schema_version: 'SchemaVersion') -> None:
6969

7070
@property
7171
def schema_version(self) -> 'SchemaVersion':
72-
"""get the schema version."""
72+
"""Get the schema version."""
7373
return self.__schema_version
7474

7575
@property
7676
@abstractmethod
7777
def output_format(self) -> OutputFormat:
78-
"""get the format."""
78+
"""Get the format."""
7979
...
8080

8181
@property
8282
@abstractmethod
8383
def _schema_file(self) -> Optional[str]:
84-
"""get the schema file according to schema version."""
84+
"""Get the schema file according to schema version."""
8585
...
8686

8787

@@ -105,7 +105,7 @@ def make_schemabased_validator(output_format: OutputFormat, schema_version: 'Sch
105105

106106
def make_schemabased_validator(output_format: OutputFormat, schema_version: 'SchemaVersion'
107107
) -> 'BaseSchemabasedValidator':
108-
"""get the default Schema-based Validator for a certain :class:``OutputFormat``.
108+
"""Get the default Schema-based Validator for a certain :class:`OutputFormat`.
109109
110110
Raises error when no instance could be made.
111111
"""

0 commit comments

Comments
 (0)