Skip to content

(assertions): misformatted doc string causes generated docs to cut off information #27392

@jishi

Description

@jishi

Describe the issue

I was about to file a PR to clarify syntax for the Template.findParameters() call, but when I looked at the source, the documentation for parameters has been correct for 2 years. See this:

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/assertions/lib/template.ts#L183

However, the latest documentation for this method is missing the * info. Isn't the online documentation generated from the comments? Why is the crucial information about this omitted here?

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrparameterslogicalid-props

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/assertionsRelated to the @aws-cdk/assertv2 packagebugThis issue is a bug.documentationThis is a problem with documentation.effort/smallSmall work item – less than a day of effortgood first issueRelated to contributions. See CONTRIBUTING.mdhacktoberfestGood issue for hacktoberfest-ersp2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions