fix: improved the documentation description (#1147)

KusionStack · Jun 6, 2024 · 1728745 · 1728745
1 parent 389d3ee
commit 1728745
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/pkg/domain/constant/source.go b/pkg/domain/constant/source.go
@@ -16,8 +16,10 @@ var (
 )
 
 const (
+	// SourceProviderTypeGit represents git source provider type.
+	SourceProviderTypeGit SourceProviderType = "git"
+
 	// SourceProviderTypeGithub represents github source provider type.
-	SourceProviderTypeGit    SourceProviderType = "git"
 	SourceProviderTypeGithub SourceProviderType = "github"
 
 	// SourceProviderTypeOCI represents oci source provider type.

diff --git a/pkg/domain/constant/stack.go b/pkg/domain/constant/stack.go
@@ -10,11 +10,11 @@ type StackState string
 
 // These constants represent the possible states of a stack.
 const (
-	// The stack has not been synced with the remote runtime.
+	// StackStateUnSynced represents state of stack has not been synced with the remote runtime.
 	StackStateUnSynced StackState = "UnSynced"
-	// The stack is synced with the remote runtime.
+	// StackStateSynced represents state of stack is synced with the remote runtime.
 	StackStateSynced StackState = "Synced"
-	// The stack has out of sync from the remote runtime.
+	// StackStateOutOfSync represents state of stack has out of sync from the remote runtime.
 	StackStateOutOfSync StackState = "OutOfSync"
 )