Fixed docstrings

This commit is contained in:
Dimitris Zlatanidis 2024-05-19 22:46:17 +03:00
parent 0fa2555b41
commit 975bca6883

View file

@ -6,16 +6,13 @@ from pathlib import Path
class TomlErrors: # pylint: disable=[R0903] class TomlErrors: # pylint: disable=[R0903]
"""Raise an error message for toml files."""
"""
Raise an error message for toml files.
"""
def __init__(self): def __init__(self):
self.tool_name: str = 'slpkg' self.tool_name: str = 'slpkg'
def raise_toml_error_message(self, error: str, toml_file: Path) -> None: def raise_toml_error_message(self, error: str, toml_file: Path) -> None:
""" A general error message for .toml configs files. """ """A general error message for .toml configs files."""
raise SystemExit(f"\n{self.tool_name}: Error: {error}: in the configuration\n" raise SystemExit(f"\n{self.tool_name}: Error: {error}: in the configuration\n"
f"file '{toml_file}', edit the file and check for errors,\n" f"file '{toml_file}', edit the file and check for errors,\n"
f"or if you have upgraded the '{self.tool_name}' maybe you need to run:\n" f"or if you have upgraded the '{self.tool_name}' maybe you need to run:\n"