Skip to content

Commit cc917f4

Browse files
author
Jordan Nimlos
committed
add doc comments to IsVersionSupported and IsSettingSupported funcs
Signed-off-by: Jordan Nimlos <[email protected]>
1 parent b55e770 commit cc917f4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

internal/provider/server_interface.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ func (si *ServerInterface) InitClients(ctx context.Context) diag.Diagnostics {
167167
return diags
168168
}
169169

170+
// Checks that any specific setting required for the feature is configured/enabled on the server.
170171
func (si *ServerInterface) IsSettingSupported(ctx context.Context, fc features.FeatureConstraint) bool {
171172
if fc.RequiredSettings == nil || len(*fc.RequiredSettings) == 0 {
172173
return true
@@ -206,6 +207,7 @@ func (si *ServerInterface) IsSettingSupported(ctx context.Context, fc features.F
206207
return true
207208
}
208209

210+
// Checks that the server version meets the minimum version required for the feature.
209211
func (si *ServerInterface) IsVersionSupported(fc features.FeatureConstraint) bool {
210212
if fc.MinVersion == nil {
211213
return true

0 commit comments

Comments
 (0)