aws / aws/jsii

jsii-pacmak: H5 tags on Markdown files break Python packaging

Open
#4,418 0 comments 0 reactions 0 assignees View on GitHub
bug p2
Dominant language
TypeScript
Stars
2.9k
Forks
267
Avg merge
1d 25m
Merged PRs (30d)
14

Description

### Describe the bug

.md files that have H5 tags (`#####`) and are included to be packaged is breaking packaging with:
`TypeError: Cannot read properties of undefined (reading 'repeat')`

### Expected Behavior

jsii-pacmak completes Python packaging successfully

### Current Behavior

`TypeError: Cannot read properties of undefined (reading 'repeat')`

### Reproduction Steps

I have inline documentation to be generated by `jsii-docgen`. I have no issues when I use H1-H4 header tags in my JsDoc-style comments. But when I use H5 header tags (`#####`), jsii-pacmak fails on Python packaging. This completes successfully for Javascript. Compilation succeeds successfully.

### Possible Solution

Unknown

### Additional Information/Context

_No response_

### SDK version used

5.3.13/1.94.0

### Environment details (OS name and version, etc.)

macOS Sonoma

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the failure in jsii-pacmak using a Markdown file with an H5 heading, then trace how jsii-docgen output is consumed during Python packaging. Compare the successful H1-H4 and JavaScript cases. Done means Python packaging completes successfully for content containing H5 tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
build-system, tooling
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.