aws / aws/jsii

Generated python docs incorrectly adds underscore to prop

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

Description

### Describe the bug

The generated Python docs incorrectly shows `memory_limit_mi_b` as the property when there should be no underscore in `mi_b`. [Seen here](https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ApplicationLoadBalancedFargateService.html)

This is likely because Python is detecting the capital B as a new "word"

### Expected Behavior

docs show `memory_limit_mib`

### Current Behavior

docs show `memory_limit_mi_b`

### Reproduction Steps

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ApplicationLoadBalancedFargateService.html
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ApplicationLoadBalancedFargateServiceProps.html

### Possible Solution

_No response_

### Additional Information/Context

_No response_

### SDK version used

.

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

.

Contributor guide

Open the contributing guide

Research direction

Start with the two linked generated AWS CDK Python documentation pages and compare the displayed property name with the expected memory_limit_mib. Trace the jsii name conversion or Python documentation generation entry point responsible for that output, then verify that both pages render the property without the extra underscore.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.