GitHub-Proxy/Cura
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura synced 2025-08-15 06:05:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
printer-linter/src/printerlinter/diagnostic.py
View File

@ -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.

2
printer-linter/src/printerlinter/linters/diagnostic_generator.py
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