Browse Source

Add documentation

Done during issue CURA-5034.
Ghostkeeper 6 years ago
parent
commit
efe4d3734d
1 changed files with 6 additions and 5 deletions
  1. 6 5
      plugins/XmlMaterialProfile/XmlMaterialValidator.py

+ 6 - 5
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.
 # 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
     @classmethod
-    def validateMaterialMetaData(cls, validation_metadata):
+    def validateMaterialMetaData(cls, validation_metadata: Dict[str, Any]):
 
 
         if validation_metadata.get("GUID") is None:
         if validation_metadata.get("GUID") is None:
             return "Missing GUID"
             return "Missing GUID"