Updated documentation

Contributes to CURA-6096
This commit is contained in:
jelle Spijker 2021-09-01 18:32:40 +02:00 committed by Jelle Spijker
parent 7aa08d4acd
commit f80e1ec279
No known key found for this signature in database
GPG key ID: 6662DC033BE6B99A

View file

@ -24,6 +24,14 @@ class QualityDatabaseHandler(DatabaseMetadataContainerController):
self.container_type = InstanceContainer self.container_type = InstanceContainer
def groomMetadata(self, metadata: metadata_type) -> metadata_type: def groomMetadata(self, metadata: metadata_type) -> metadata_type:
"""
Ensures that the metadata is in the order of the field keys and has the right size.
if the metadata doesn't contains a key which is stored in the DB it will add it as
an empty string. Key, value pairs that are not stored in the DB are dropped.
If the `global_quality` isn't set it well default to 'False'
:param metadata: The container metadata
"""
if "global_quality" not in metadata: if "global_quality" not in metadata:
metadata["global_quality"] = "False" metadata["global_quality"] = "False"
return super().groomMetadata(metadata) return super().groomMetadata(metadata)