resolver: document that SetDefaultScheme should be called at init time (

#2217) fixes #2216
grpc · Jul 16, 2018 · c8fcd32 · c8fcd32
1 parent 1dab6d1
commit c8fcd32
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/resolver/resolver.go b/resolver/resolver.go
@@ -49,8 +49,12 @@ func Get(scheme string) Builder {
 	return nil
 }
 
-// SetDefaultScheme sets the default scheme that will be used.
-// The default default scheme is "passthrough".
+// SetDefaultScheme sets the default scheme that will be used. The default
+// default scheme is "passthrough".
+//
+// NOTE: this function must only be called during initialization time (i.e. in
+// an init() function), and is not thread-safe. The scheme set last overrides
+// previously set values.
 func SetDefaultScheme(scheme string) {
 	defaultScheme = scheme
 }