diff --git a/printer-linter/src/printerlinter/diagnostic.py b/printer-linter/src/printerlinter/diagnostic.py index a379ff6ba2..d5eb237c29 100644 --- a/printer-linter/src/printerlinter/diagnostic.py +++ b/printer-linter/src/printerlinter/diagnostic.py @@ -10,7 +10,7 @@ class Diagnostic: @param file: The path to the file this diagnostic is for. @param diagnostic_name: The name of the diagnostic rule that spawned this result. A list can be found in .printer-linter. - @param message: A message explaining the issue with this piece of text. + @param message: A message explaining the issue with this file. @param level: How important this diagnostic is, ranges from Warning -> Error. @param offset: The offset in file where the issue is. @param replacements: A list of Replacement that contain replacement text. diff --git a/printer-linter/src/printerlinter/linters/diagnostic_generator.py b/printer-linter/src/printerlinter/linters/diagnostic_generator.py index 52f132a3c8..b259487828 100644 --- a/printer-linter/src/printerlinter/linters/diagnostic_generator.py +++ b/printer-linter/src/printerlinter/linters/diagnostic_generator.py @@ -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