Skip to content

Commit

Permalink
docs: fix some doc strings
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck authored Oct 1, 2024
1 parent fe979b7 commit 4fa8fc1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions cyclonedx/validation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ def validate_str(self, data: str) -> Optional[ValidationError]:
:param data: the data string to validate
:return: validation error
:retval None: if `data` is valid
:retval ValidationError: if `data` is invalid
:retval None: if ``data`` is valid
:retval ValidationError: if ``data`` is invalid
"""
...

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

@property
def schema_version(self) -> 'SchemaVersion':
"""get the schema version."""
"""Get the schema version."""
return self.__schema_version

@property
@abstractmethod
def output_format(self) -> OutputFormat:
"""get the format."""
"""Get the format."""
...

@property
@abstractmethod
def _schema_file(self) -> Optional[str]:
"""get the schema file according to schema version."""
"""Get the schema file according to schema version."""
...


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

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

0 comments on commit 4fa8fc1

Please sign in to comment.