aws / aws/jsii

documentation generator does not gracefully catch unclosed code blocks

Open
#3,576 1 comment 0 reactions 0 assignees View on GitHub
bug effort/small p2
Dominant language
TypeScript
Stars
2.9k
Forks
267
Avg merge
1d 25m
Merged PRs (30d)
14

Description

### 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

Contributor guide

Open the contributing guide

Research direction

Start with the reproduction details in aws/aws-cdk#20623 and trace the jsii documentation generator's handling of code blocks. Compare the generated output for an unclosed block with the expected behavior, then add coverage and verify that the generator reports the problem or prevents corrupted documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.