Add godoc, remove unused parameter.

algorand · Nov 9, 2023 · 222173e · 222173e
1 parent c389f27
commit 222173e
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/cmd/algocfg/profileCommand.go b/cmd/algocfg/profileCommand.go
@@ -143,7 +143,7 @@ var printProfileCmd = &cobra.Command{
 		if err != nil {
 			reportErrorf("%v", err)
 		}
-		err = codecs.WriteNonDefaultValues(os.Stdout, cfg, config.GetDefaultLocal(), nil, true)
+		err = codecs.WriteNonDefaultValues(os.Stdout, cfg, config.GetDefaultLocal(), nil)
 		if err != nil {
 			reportErrorf("Error writing config file to stdout: %s", err)
 		}
@@ -175,7 +175,7 @@ var setProfileCmd = &cobra.Command{
 					return
 				}
 			}
-			err = codecs.SaveNonDefaultValuesToFile(file, cfg, config.GetDefaultLocal(), nil, true)
+			err = codecs.SaveNonDefaultValuesToFile(file, cfg, config.GetDefaultLocal(), nil)
 			if err != nil {
 				reportErrorf("Error saving updated config file '%s' - %s", file, err)
 			}

diff --git a/cmd/algocfg/resetCommand.go b/cmd/algocfg/resetCommand.go
@@ -63,7 +63,7 @@ var resetCmd = &cobra.Command{
 			}
 
 			file := filepath.Join(dataDir, config.ConfigFilename)
-			err = codecs.SaveNonDefaultValuesToFile(file, cfg, defaults, nil, true)
+			err = codecs.SaveNonDefaultValuesToFile(file, cfg, defaults, nil)
 			if err != nil {
 				reportWarnf("Error saving updated config file '%s' - %s", file, err)
 				anyError = true

diff --git a/cmd/algocfg/setCommand.go b/cmd/algocfg/setCommand.go
@@ -66,7 +66,7 @@ var setCmd = &cobra.Command{
 			}
 
 			file := filepath.Join(dataDir, config.ConfigFilename)
-			err = codecs.SaveNonDefaultValuesToFile(file, cfg, config.GetDefaultLocal(), nil, true)
+			err = codecs.SaveNonDefaultValuesToFile(file, cfg, config.GetDefaultLocal(), nil)
 			if err != nil {
 				reportWarnf("Error saving updated config file '%s' - %s", file, err)
 				anyError = true

diff --git a/config/localTemplate.go b/config/localTemplate.go
@@ -652,7 +652,7 @@ func (cfg Local) SaveAllToDisk(root string) error {
 func (cfg Local) SaveToFile(filename string) error {
 	var alwaysInclude []string
 	alwaysInclude = append(alwaysInclude, "Version")
-	return codecs.SaveNonDefaultValuesToFile(filename, cfg, defaultLocal, alwaysInclude, true)
+	return codecs.SaveNonDefaultValuesToFile(filename, cfg, defaultLocal, alwaysInclude)
 }
 
 // DNSSecuritySRVEnforced returns true if SRV response verification enforced

diff --git a/util/codecs/json.go b/util/codecs/json.go
@@ -69,7 +69,10 @@ func SaveObjectToFile(filename string, object interface{}, prettyFormat bool) er
 	return writeBytes(f, object, prettyFormat)
 }
 
-func WriteNonDefaultValues(writer io.Writer, object, defaultObject interface{}, ignore []string, prettyFormat bool) error {
+// WriteNonDefaultValues writes object to a writer as json, but only fields that are not
+// currently set to be the default value.
+// Optionally, you can specify an array of field names to always include.
+func WriteNonDefaultValues(writer io.Writer, object, defaultObject interface{}, ignore []string) error {
 	// Iterate one line at a time, parse Name
 	// If ignore contains Name, don't delete
 	// Use reflection to compare object[Name].value == defaultObject[Name].value
@@ -151,15 +154,15 @@ func WriteNonDefaultValues(writer io.Writer, object, defaultObject interface{},
 // SaveNonDefaultValuesToFile saves an object to a file as json, but only fields that are not
 // currently set to be the default value.
 // Optionally, you can specify an array of field names to always include.
-func SaveNonDefaultValuesToFile(filename string, object, defaultObject interface{}, ignore []string, prettyFormat bool) error {
+func SaveNonDefaultValuesToFile(filename string, object, defaultObject interface{}, ignore []string) error {
 	outFile, err := os.Create(filename)
 	if err != nil {
 		return err
 	}
 	defer outFile.Close()
 	writer := bufio.NewWriter(outFile)
 
-	WriteNonDefaultValues(writer, object, defaultObject, ignore, prettyFormat)
+	WriteNonDefaultValues(writer, object, defaultObject, ignore)
 	if err == nil {
 		writer.Flush()
 	}