Azure / Azure/bicep

Automatically add descriptions to bicepparams

Open
#14,936 2 comments 23 reactions 0 assignees View on GitHub
enhancement Needs: Upvote
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

**Is your feature request related to a problem? Please describe.**
The parameters in a bicep param currently do not have a default description, this makes them less clear to fill in. We now need to look at the .bicep file to see the description of a parameter.

**Describe the solution you'd like**
When I generate a bicepparam file through vscode, I would love if the descriptions of each of the parameters in de param file has the description we have specified in the bicep file. This should probably be an optional but easiliy accesible feature.

This way if someone wants to deploy the bicep they need to only look at the bicepparam and they don't have to look at the bicep file.

```[tasklist]
### Tasks
```

Contributor guide

Open the contributing guide

Research direction

Start by tracing the VS Code bicepparam generation entry point and how parameter descriptions are represented in the .bicep file. Confirm the optional behavior and define done as generated bicepparam files carrying each source parameter description, so users do not need to open the .bicep file.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, vscode
Domain
cloud, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.