Skip to content

Incorrect/missing code formatting on some examples #2990

Open

Description

What happened?

While browsing the API docs for the Azure Native provider, I noted that numerous examples were incorrectly formatted or were missing formatting. While this doesn't make it impossible to use the example for guidance, it does significantly raise the level of effort required. Based on what I have observed so far, this only seems to affect examples in Go, and not any other languages.

URLs of specific examples:
https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/storageaccount/ (see the second example in Go)
https://www.pulumi.com/registry/packages/azure-native/api-docs/compute/virtualmachine/ (see the first example in Go)

I strongly suspect there are more, but these are the ones I can for sure confirm.

I viewed these using Firefox, and have not checked any other browsers.

Example

https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/storageaccount/ (see the second example in Go)
https://www.pulumi.com/registry/packages/azure-native/api-docs/compute/virtualmachine/ (see the first example in Go)

Output of pulumi about

N/A

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    area/docsImprovements or additions to documentationimpact/usabilitySomething that impacts users' ability to use the product easily and intuitivelykind/bugSome behavior is incorrect or out of spec

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions