Skip to content

documentation generator does not gracefully catch unclosed code blocks #3576

@kaizencc

Description

@kaizencc

Describe the bug

See aws/aws-cdk#20623

Missing code block causes CDK documentation to be corrupted. In addition to fixing the instance, we should try to throw an error if this happens.

Expected Behavior

An error thrown, or some way to make sure the documentation that shows up is not corrupted

Current Behavior

Weird documentation shows up.

Reproduction Steps

See aws/aws-cdk#20623

Possible Solution

No response

Additional Information/Context

No response

SDK version used

CDK

Environment details (OS name and version, etc.)

MacOs

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugThis issue is a bug.effort/smallSmall work item – less than a day of effortp2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions