enhance comment describing what the function does

Author: umbynos

cli/arguments/reference.go

@@ -56,6 +56,10 @@ func ParseReferences(args []string) ([]*Reference, error) {
 }
 
 // ParseReference parses a string and returns a Reference object.
+// It tries to infer the platform the user is asking for.
+// To achieve that, it tries to use github.com/arduino/arduino-cli/commands/core.GetPlatform
+// Note that the Reference is returned rightaway if the arg inserted by the user mathes perfectly one in the response of core.GetPlatform
+// A MultiplePlatformsError is returned if the platform searched by the user matches multiple platforms
 func ParseReference(arg string) (*Reference, error) {
 	logrus.Infof("Parsing reference %s", arg)
 	ret := &Reference{}