bicep icon indicating copy to clipboard operation
bicep copied to clipboard

"Show documentation" in hover should have a line break beforehand to avoid picking up markdown styles from description

Open StephenWeatherford opened this issue 2 years ago • 1 comments

Hover over 'modSshPublicKey' in this code:

// avm module (no source)
module modSshPublicKey 'br/public:avm/res/compute/ssh-public-key:0.2.2' = {
  name: 'modSshPublicKey'
  params: {
    name: 'sshPublicKey'
  }
}

You see this: image

Expected: Show Documentation should not be caught up in the quoted line in the module description at https://github.com/Azure/bicep-registry-modules/blob/149cf09cc9b8baadbe43c484f785befb4036dc50/avm/res/compute/ssh-public-key/main.bicep:

metadata description = '''This module deploys a Public SSH Key.

> Note: The resource does not auto-generate the key for you.'''

StephenWeatherford avatar Dec 14 '23 19:12 StephenWeatherford

This is a formatting issue with no impact to functionality. Not top priority.

puicchan avatar Aug 12 '24 23:08 puicchan