putting doc change in stage.go for md generator to pick up

Snowflake-Labs · Dec 26, 2024 · c30314e · c30314e
1 parent 590aecb
commit c30314e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 9 deletions.
diff --git a/examples/resources/snowflake_stage/resource.tf b/examples/resources/snowflake_stage/resource.tf
@@ -5,11 +5,4 @@ resource "snowflake_stage" "example_stage" {
   database    = "EXAMPLE_DB"
   schema      = "EXAMPLE_SCHEMA"
   credentials = "AWS_KEY_ID='${var.example_aws_key_id}' AWS_SECRET_KEY='${var.example_aws_secret_key}'"
-}
-/*
-  * Examples of usage for `file_format`:
-    * with hardcoding value: `file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME"`
-    * from dynamic value: `file_format = "FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}"`
-    * from expression: `file_format = format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name)`
-  * Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265)
-*/
+}
diff --git a/pkg/resources/stage.go b/pkg/resources/stage.go
@@ -57,7 +57,7 @@ var stageSchema = map[string]*schema.Schema{
 	"file_format": {
 		Type:             schema.TypeString,
 		Optional:         true,
-		Description:      "Specifies the file format for the stage. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check [#2679](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2679)). For now, omit the default values; it will be fixed in the upcoming provider versions.",
+		Description:      "Specifies the file format for the stage. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check [#2679](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2679)). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: <b>1. with hardcoding value:</b> `file_format=\"FORMAT_NAME = DB.SCHEMA.FORMATNAME\"` <b>2. from dynamic value:</b> `file_format = \"FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}\"` <b>3. from expression:</b> `file_format = format(\"FORMAT_NAME =%s.%s.MYFILEFORMAT\", var.db_name, each.value.schema_name)`. Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265)",
 		DiffSuppressFunc: suppressQuoting,
 	},
 	"copy_options": {