chore: add warning comments

Marina-Sakai · Feb 10, 2025 · c37f55a · c37f55a
1 parent 016a9de
commit c37f55a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/pkg/generic/pbidl_provider.go b/pkg/generic/pbidl_provider.go
@@ -56,6 +56,8 @@ func NewPbContentProvider(main string, includes map[string]string) (PbDescriptor
 	return p, nil
 }
 
+// UpdateIDL updates idl
+// NOTE: Since an IDL update is asynchronous, it may not be applied immediately, potentially causing a temporary data inconsistency.
 func (p *PbContentProvider) UpdateIDL(main string, includes map[string]string) error {
 	sd, err := parseProto(main, includes)
 	if err != nil {
@@ -140,6 +142,8 @@ func NewPbContentProviderWithDynamicGo(ctx context.Context, options dproto.Optio
 	return p, nil
 }
 
+// UpdateIDL updates idl
+// NOTE: Since an IDL update is asynchronous, it may not be applied immediately, potentially causing a temporary data inconsistency.
 func (p *PbFileProviderWithDynamicGo) UpdateIDL(ctx context.Context, options dproto.Options, mainPath, mainContent string, includes map[string]string) error {
 	sd, err := options.NewDesccriptorFromContent(ctx, mainPath, mainContent, includes)
 	if err != nil {

diff --git a/pkg/generic/thriftidl_provider.go b/pkg/generic/thriftidl_provider.go
@@ -205,7 +205,8 @@ func NewThriftContentProviderWithDynamicGo(main string, includes map[string]stri
 	return p, nil
 }
 
-// UpdateIDL ...
+// UpdateIDL updates idl
+// NOTE: Since an IDL update is asynchronous, it may not be applied immediately, potentially causing a temporary data inconsistency.
 func (p *ThriftContentProvider) UpdateIDL(main string, includes map[string]string) error {
 	var svc *descriptor.ServiceDescriptor
 	tree, err := ParseContent(defaultMainIDLPath, main, includes, false)
@@ -388,7 +389,8 @@ func NewThriftContentWithAbsIncludePathProviderWithDynamicGo(mainIDLPath string,
 	return p, nil
 }
 
-// UpdateIDL update idl by given args
+// UpdateIDL updates idl
+// NOTE: Since an IDL update is asynchronous, it may not be applied immediately, potentially causing a temporary data inconsistency.
 func (p *ThriftContentWithAbsIncludePathProvider) UpdateIDL(mainIDLPath string, includes map[string]string) error {
 	mainIDLContent, ok := includes[mainIDLPath]
 	if !ok {