cleaned up docstring

Author: andrewelamb

synapseclient/extensions/curator/schema_generation.py

@@ -114,6 +114,14 @@ class ListColumnType(ColumnType):
 ]
 
 
+# Translates list types to their atomic type
+LIST_TYPE_DICT = {
+    ListColumnType.STRING_LIST: AtomicColumnType.STRING,
+    ListColumnType.INTEGER_LIST: AtomicColumnType.INTEGER,
+    ListColumnType.BOOLEAN_LIST: AtomicColumnType.BOOLEAN,
+}
+
+
 class JSONSchemaFormat(Enum):
     """
     Allowed formats by the JSON Schema validator used by Synapse: https://github.com/everit-org/json-schema#format-validators
@@ -135,14 +143,6 @@ class JSONSchemaFormat(Enum):
     RELATIVE_JSON_POINTER = "relative-json-pointer"
 
 
-# Translates list types to their atomic type
-LIST_TYPE_DICT = {
-    ListColumnType.STRING_LIST: AtomicColumnType.STRING,
-    ListColumnType.INTEGER_LIST: AtomicColumnType.INTEGER,
-    ListColumnType.BOOLEAN_LIST: AtomicColumnType.BOOLEAN,
-}
-
-
 class ValidationRuleName(Enum):
     """Names of validation rules that are used to create JSON Schema"""
 
@@ -655,6 +655,8 @@ def gather_csv_attributes_relationships(
 
         # get attributes from Attribute column
         attributes = model_df.to_dict("records")
+
+        # Check for presence of optional columns
         model_includes_column_type = "columnType" in model_df.columns
         model_includes_format = "Format" in model_df.columns
 
@@ -715,19 +717,19 @@ def parse_column_type(self, attr: dict) -> dict:
 
         return {"ColumnType": column_type}
 
-    def parse_format(self, attr: dict) -> dict[str, str]:
-        """Parse the format for a given attribute.
+    def parse_format(self, attribute_dict: dict) -> dict[str, str]:
+        """Finds the format value if it exists and returns it as a dictionary.
 
         Args:
-            attr: The attribute dictionary.
+            attribute_dict: The attribute dictionary.
 
         Returns:
-            A dictionary containing the parsed column type information if present
+            A dictionary containing the format value if it exists
             else an empty dict
         """
         from pandas import isna
 
-        format_value = attr.get("Format")
+        format_value = attribute_dict.get("Format")
 
         if isna(format_value):
             return {}
@@ -736,7 +738,7 @@ def parse_format(self, attr: dict) -> dict[str, str]:
 
         check_allowed_values(
             self.dmr,
-            entry_id=attr["Format"],
+            entry_id=attribute_dict["Format"],
             value=format_string,
             relationship="format",
         )