search

aws / jsii

jsii allows code in any language to naturally interact with JavaScript classes. It is the technology that enables the AWS Cloud Development Kit to deliver polyglot libraries from a single codebase!
https://aws.github.io/jsii
Apache License 2.0
2.65k stars 245 forks source link

documentation generator does not gracefully catch unclosed code blocks #3576

Open kaizencc opened 2 years ago

kaizencc commented 2 years ago

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 commented 1 year ago

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