Skip to content

C# documentation comments not included in generated SDK #1070

Description

@davidwalschots

What happened?

I'm importing a locally generated Pulumi plugin of a component written in C# into a C# stack project. Executing pulumi package add {path-to-component} generates the .NET SDK and adds it to the project.

The resulting SDK does not contain the documentation comments found on the component or its arguments (transitively). This means I cannot communicate any useful information to consumers of the component. I would expect any documentation comments to persist across this boundary.

Example

The following input:

/// <summary>
/// My useful summary comment.
/// 
/// My useful usage example:
/// 
/// <code>
/// 
/// </code>
/// </summary>
public sealed class MyComponent : ComponentResource
{
    // ...
}

Results in the following generated SDK which does not include the documentation:

[MyComponentResourceTypeAttribute("...")]
public class MyComponent: ComponentResource
{
}

Output of pulumi about

Azure.Core 1.55.0
IPNetwork2 4.2.0
OpenTelemetry.Api 1.15.3
OpenTelemetry.Exporter.OpenTelemetryProtocol 1.15.3
Pulumi 3.103.1
Pulumi.AzureAD 5.53.5
Pulumi.AzureNative 3.17.0

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).

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions