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

Markdown visualization of description differences #14864

Closed
slavizh opened this issue Aug 20, 2024 · 1 comment · Fixed by #14870
Closed

Markdown visualization of description differences #14864

slavizh opened this issue Aug 20, 2024 · 1 comment · Fixed by #14870
Assignees
Labels
devdiv Related to Bicep tooling efforts in DevDiv Needs: Triage 🔍

Comments

@slavizh
Copy link
Contributor

slavizh commented Aug 20, 2024

Bicep version
Bicep CLI version 0.29.47 (132ade5)

Describe the bug
There is a difference of how Markdown is visualized/interpreted in user defined types bicep template and bicep parameters files. In the latter the visualization is not correct.

To Reproduce
Example:
main.bicep

type fooType = {
  @description('''Description

    # Title1

    Some text

    ## Title 2

    Some text:

    ```sql
    AzureMetrics
    | where ResourceProvider == 'MICROSOFT.ANALYSISSERVICES'
    ```

    Some text

      * Bullet1
      * Bullet2

    Some text

    ## Title 3

    ```json
    {
      "key": "value",
      "key2": "value2",
      "key3": 1
    }
    ```
    ''')
  foo1: string?
  @description('''Description

    ```sql
    AzureMetrics
    | where ResourceProvider == 'MICROSOFT.ANALYSISSERVICES'
    ```
    ''')
  foo2: string?
}

param foo fooType = {}

parameters.bicepparam. Note using needs to point to container registry

using ''
param foo = {

}

The visualization of the descriptions in .bicep file:
image
image

image

Visualization of the descriptions in .bicepparam file:

image

image

Note that the issue appears if you point using to container registry. If you reference local .bicep file visualization is ok.

I believe this is not the first time this happens so may you can somehow use the same code or sync those two functions that do those things in order to avoid differences in those and having to report them when it happens.

Additional context
Add any other context about the problem here.

@slavizh
Copy link
Contributor Author

slavizh commented Aug 20, 2024

@anthony-c-martin @jeskew I know you have previously worked/fixed on this functionality.

@stephaniezyen stephaniezyen added the devdiv Related to Bicep tooling efforts in DevDiv label Aug 21, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Bicep Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devdiv Related to Bicep tooling efforts in DevDiv Needs: Triage 🔍
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants