Skip to content

Commit

Permalink
Add backticks for field name in deprecation_message example (#9657)
Browse files Browse the repository at this point in the history
  • Loading branch information
zli82016 authored Dec 18, 2023
1 parent b0dc7d3 commit 31d4404
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/content/develop/make-a-breaking-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Set `deprecation_message` on the field. For example:
name: 'apiFieldName'
description: |
MULTILINE_FIELD_DESCRIPTION
deprecation_message: api_field_name is deprecated and will be removed in a future major release. Use other_field_name instead.
deprecation_message: "`api_field_name` is deprecated and will be removed in a future major release. Use `other_field_name` instead."
```
Replace the second sentence with an appropriate short description of the replacement path and/or the reason for
Expand All @@ -107,7 +107,7 @@ The deprecation message will automatically show up in the resource documentation
```go
"api_field_name": {
Type: schema.String,
Deprecated: "api_field_name is deprecated and will be removed in a future major release. Use other_field_name instead.",
Deprecated: "`api_field_name` is deprecated and will be removed in a future major release. Use `other_field_name` instead.",
...
}
```
Expand Down

0 comments on commit 31d4404

Please sign in to comment.