Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Short description should be added to Bicep files in /core #2466

Closed
puicchan opened this issue Jun 29, 2023 · 3 comments
Closed

Short description should be added to Bicep files in /core #2466

puicchan opened this issue Jun 29, 2023 · 3 comments
Assignees
@v-xuto
Labels
Bicep core documentation Improvements or additions to documentation
Milestone
September 2023 - ...

Comments

@puicchan
Copy link
Contributor

description should be added at the top to all Bicep files in /core to help folks understand what the module does:

metadata description = 'Short description for module...'

From 0.18 onwards, Bicep will show description in help text when mouse-over a module you reference:
image
@ghost ghost added the needs-triage For new issues label Jun 29, 2023
@rajeshkamal5050 rajeshkamal5050 added documentation Improvements or additions to documentation Bicep labels Jul 5, 2023
@ghost ghost removed the needs-triage For new issues label Jul 5, 2023
@ghost ghost removed the needs-triage For new issues label Jul 5, 2023
@rajeshkamal5050 rajeshkamal5050 added this to the August 2023 - 1.2.0 milestone Jul 5, 2023
@rajeshkamal5050
Copy link

@v-xuto can you pick this up and put out a PR for review with @jongio @savannahostrowski ?

@v-xuto
Copy link
Member

v-xuto commented Jul 6, 2023 •
edited

@v-xuto can you pick this up and put out a PR for review with @jongio @savannahostrowski ?

Sure. We will pick up this issue and create PR for it.

@zedy-wj zedy-wj mentioned this issue Jul 6, 2023
Closed
@ChenxiJiang333 ChenxiJiang333 mentioned this issue Jul 13, 2023
Merged
@v-xuto
Copy link
Member

v-xuto commented Jul 14, 2023

@rajeshkamal5050 PR #2534 is ready, please review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@v-xuto v-xuto

Labels
Bicep core documentation Improvements or additions to documentation
Projects
None yet
Milestone
September 2023 - 1.3.0
Development

No branches or pull requests
3 participants
@puicchan @rajeshkamal5050 @v-xuto