review comments

Author: mtojek

scripts/docsgen/main.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/coder/terraform-provider-coder/provider"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"golang.org/x/xerrors"
 )
 
 // This script patches Markdown docs generated by `terraform-plugin-docs` to expose the original deprecation message.
@@ -35,7 +36,7 @@ func exposeDeprecationMessage(p *schema.Provider) error {
 
 		err := adjustDocFile(docFile, dataSource.Schema)
 		if err != nil {
-			return err
+			return xerrors.Errorf("unable to adjust data-source doc file (data-source: %s): %w", dataSourceName, err)
 		}
 	}
 
@@ -45,30 +46,30 @@ func exposeDeprecationMessage(p *schema.Provider) error {
 
 		err := adjustDocFile(docFile, resource.Schema)
 		if err != nil {
-			return err
+			return xerrors.Errorf("unable to adjust resource doc file (resource: %s): %w", resourceName, err)
 		}
 	}
 
 	// Patch index
 	docFile := filepath.Join("docs", "index.md")
 	err := adjustDocFile(docFile, p.Schema)
 	if err != nil {
-		return err
+		return xerrors.Errorf("unable to adjust index doc file: %w", err)
 	}
 	return nil
 }
 
 func adjustDocFile(docPath string, schemas map[string]*schema.Schema) error {
 	doc, err := os.ReadFile(docPath)
 	if err != nil {
-		return err
+		return xerrors.Errorf("can't read the source doc file: %w", err)
 	}
 
 	result := writeDeprecationMessage(doc, schemas)
 
 	err = os.WriteFile(docPath, result, 0644)
 	if err != nil {
-		return err
+		return xerrors.Errorf("can't write modified doc file: %w", err)
 	}
 	return nil
 }
@@ -81,7 +82,8 @@ func writeDeprecationMessage(doc []byte, schemas map[string]*schema.Schema) []by
 
 		sch := schemas[string(propertyName)]
 		if string(description) != sch.Description {
-			return m // same property name but description does not match, most likely a different property
+			log.Printf("warn: same property name `%s` but description does not match, most likely a different property", propertyName)
+			return m
 		}
 		return bytes.Replace(m, []byte("Deprecated"), []byte(fmt.Sprintf("Deprecated: %s", sch.Deprecated)), 1)
 	})