jsii icon indicating copy to clipboard operation
jsii copied to clipboard
verified publisher icon aws

documentation generator does not gracefully catch unclosed code blocks

Open kaizencc opened this issue 3 years ago • 1 comments

Describe the bug

See https://github.com/aws/aws-cdk/issues/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 https://github.com/aws/aws-cdk/issues/20623

Possible Solution

No response

Additional Information/Context

No response

SDK version used

CDK

Environment details (OS name and version, etc.)

MacOs

kaizencc avatar Jun 06 '22 14:06 kaizencc

Another example of nonexistent error handling in the doc generator: https://github.com/aws/aws-cdk/pull/24204

kaizencc avatar Feb 16 '23 20:02 kaizencc