Skip to content

Changed MarkdownDescription function to follow the markdown convention to use backticks to surround code#332

Open
v-kenntan wants to merge 3 commits intohashicorp:mainfrom
v-kenntan:markdown-description-reformat
Open

Changed MarkdownDescription function to follow the markdown convention to use backticks to surround code#332
v-kenntan wants to merge 3 commits intohashicorp:mainfrom
v-kenntan:markdown-description-reformat

Conversation

@v-kenntan
Copy link

@v-kenntan v-kenntan commented Mar 9, 2026

Description

This PR aims to add backticks to allow the MarkdownDescription function to follow the markdown convention of using backticks to surround code. Currently, both the Description function and the MarkdownDescription function shares the same output.

Rollback Plan

  • If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

None

…generation of documentation for terraform-plugin-docs
@v-kenntan v-kenntan requested a review from a team as a code owner March 9, 2026 02:23
@hashicorp-cla-app
Copy link

hashicorp-cla-app bot commented Mar 9, 2026

CLA assistant check
All committers have signed the CLA.

@hashicorp-cla-app
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@v-kenntan v-kenntan changed the title Added backticks to MarkdownDescription function to allow better auto generation of documentation for terraform-plugin-docs Changed MarkdownDescription function to follow the markdown convention to use backticks to surround code Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant