fix: More explicit names and descriptions for `annotationHandler.sync…

…` method
databricks · Dec 17, 2024 · 0037671 · 0037671
1 parent 3049184
commit 0037671
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go
@@ -109,8 +109,8 @@ func (d *annotationHandler) addAnnotations(typ reflect.Type, s jsonschema.Schema
 	return s
 }
 
-// Adds empty annotations with placeholders to the annotation file
-func (d *annotationHandler) sync(outputPath string) error {
+// Writes missing annotations with placeholder values back to the annotation file
+func (d *annotationHandler) syncWithMissingAnnotations(outputPath string) error {
 	existingFile, err := os.ReadFile(outputPath)
 	if err != nil {
 		return err

diff --git a/bundle/internal/schema/main.go b/bundle/internal/schema/main.go
@@ -163,7 +163,8 @@ func generateSchema(workdir, outputFile string) {
 		log.Fatal(err)
 	}
 
-	err = a.sync(annotationsPath)
+	// Overwrite the input annotation file, adding missing annotations
+	err = a.syncWithMissingAnnotations(annotationsPath)
 	if err != nil {
 		log.Fatal(err)
 	}