Azure / Azure/bicep

User Defined Types - Support for description on type to be inherited on parameters

Open
#10,881 4 comments 0 reactions 0 assignees View on GitHub
Needs: Attention :wave: Needs: Upvote type system
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 2h
Merged PRs (30d)
79

Description

**Bicep version**
Bicep CLI version 0.17.1 (d423d61882)

**Describe the bug**
Imagine having the following code:

```bicep
@description('This is parameter foo.')
type fooType = int

param foo fooType
```

In that case the description of the parameter foo should be the description of the type. But intellisense does not show it.
![image](https://github.com/Azure/bicep/assets/11890856/821c9f4f-aeae-4882-a0f7-831fb5695996)

Contributor guide

Open the contributing guide

Research direction

The issue concerns Bicep CLI 0.17.1 and IntelliSense for a parameter using a described user-defined type. Start by reproducing the provided example in an editor and trace the IntelliSense/type-description path; done means the parameter displays the description inherited from its type.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, 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.