DXCDT-244: Escape dollar sign references in prompts docs #366
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Changes
As pointed out by #332 , the custom text prompts documentation references unescaped dollar signs in the example. When Terraform plan'ing the literal example, an error similar to the following will be incurred:
This PR simply corrects the documentation by escaping the dollar signs with another prepended dollar sign.
📚 References
Original issue: #332
Similar Stackoverflow issue: https://stackoverflow.com/questions/66953938/escaping-dollar-sign-in-terraform
🔬 Testing
Added custom text variable replacement to custom text tests. Also manually tested the example snippet.
📝 Checklist