From efe4d3734dfe10856999ed03f42b86aaaa25ac04 Mon Sep 17 00:00:00 2001 From: Ghostkeeper Date: Thu, 7 Jun 2018 15:49:23 +0200 Subject: [PATCH] Add documentation Done during issue CURA-5034. --- plugins/XmlMaterialProfile/XmlMaterialValidator.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/plugins/XmlMaterialProfile/XmlMaterialValidator.py b/plugins/XmlMaterialProfile/XmlMaterialValidator.py index f11c8bea4b..a23022854b 100644 --- a/plugins/XmlMaterialProfile/XmlMaterialValidator.py +++ b/plugins/XmlMaterialProfile/XmlMaterialValidator.py @@ -1,12 +1,13 @@ -# Copyright (c) 2017 Ultimaker B.V. +# Copyright (c) 2018 Ultimaker B.V. # Cura is released under the terms of the LGPLv3 or higher. +from typing import Any, Dict - -class XmlMaterialValidator(): - +## Makes sure that the required metadata is present for a material. +class XmlMaterialValidator: + ## Makes sure that the required metadata is present for a material. @classmethod - def validateMaterialMetaData(cls, validation_metadata): + def validateMaterialMetaData(cls, validation_metadata: Dict[str, Any]): if validation_metadata.get("GUID") is None: return "Missing GUID"