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.

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

Incorrect support for @description decorator on keyword var #8244

Open
SimonWahlin opened this issue Sep 4, 2022 · 1 comment
Open

Incorrect support for @description decorator on keyword var #8244

SimonWahlin opened this issue Sep 4, 2022 · 1 comment
Labels
enhancement New feature or request intermediate language Related to the intermediate language

Comments

@SimonWahlin
Copy link
Collaborator

Bicep version
Bicep CLI version 0.9.1 (a2950a1)

Describe the bug
The decorator @description() is currently supported on the keyword var, it does not generate any warnings or errors but the description is not part of the compiled ARM template.

To Reproduce
Steps to reproduce the behavior:
The following bicep code will build successfully without errors or warnings:

@description('myVarDescription')
var descriptionVar = 'varHasDescription'

output varValue string = descriptionVar

The resulting ARM template does not contain the description myVarDescription

Additional context
Can we add a FunctionFlag for SupportsDescriptionDecorator or something similar?

This would also apply for the keyword metadata and possibly import

@ghost ghost added the Needs: Triage 🔍 label Sep 4, 2022
@alex-frankel
Copy link
Collaborator

Variables do not support description in ARM Templates, so this is by design. It still provides functionality (i.e. hovers) in bicep, so that's why it works and is allowed. If we feel it's critical, we can prioritize adding support for description in ARM templates.

@alex-frankel alex-frankel added enhancement New feature or request intermediate language Related to the intermediate language and removed Needs: Triage 🔍 labels Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request intermediate language Related to the intermediate language
Projects
None yet
Development

No branches or pull requests

2 participants