Update documentation on diagnostic to be less specifically about strings. Since diagnostics can be related to other issues.

This commit is contained in:
Joey de l'Arago 2022-11-23 15:25:13 +01:00
parent d19f1f3e42
commit 0b2e409929
2 changed files with 2 additions and 2 deletions

View file

@ -7,7 +7,7 @@ from ..diagnostic import Diagnostic
class DiagnosticGenerator(ABC):
def __init__(self, file: Path, settings: dict) -> None:
""" Yields Diagnostics for file, these are suggested text replacements based on formatting rules in settings.
""" Yields Diagnostics for file, these are issues with the file such as bad text format or too large file size.
@param file: A file to generate diagnostics for
@param settings: A list of settings containing rules for creating diagnostics