aws / aws/jsii

Inconsistent naming in the py file causes exception

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

Description

### Describe the bug

[Internal code](https://code.amazon.com/packages/Python-aws-cdk-lib/blobs/aws-cdk-lib-2.33.0/--/src/aws_cdk/aws_iotwireless/__init__.py?__session=eyJ0YWJzIjpbeyJmaWxlIjoic3JjL2F3c19jZGsvYXdzX2lvdHdpcmVsZXNzIn0seyJmaWxlIjoic3JjL2F3c19jZGsvYXdzX2lvdHdpcmVsZXNzL19faW5pdF9fLnB5In1dfQ%3D%3D) shows inconsistency in naming between `supports32_bit_fCnt` and `supports32_bit_f_cnt`
In code it uses `supports32_bit_f_cnt` while in the generated doc it uses ` supports32_bit_fCnt`

This will cause exception when enduser tries to use the name in public document.
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_iotwireless/CfnDeviceProfile.html

### Expected Behavior

use consistent name

### Current Behavior

`supports32_bit_fCnt` and `supports32_bit_f_cnt` are mixed.

### Reproduction Steps

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_iotwireless/CfnDeviceProfile.html

Follow the instruction in the public doc to create cfnDeviceProfile. And set the `supports32_bit_fCnt` attribute.

You will hit exception.

### Possible Solution

_No response_

### Additional Information/Context

_No response_

### SDK version used

https://code.amazon.com/packages/Python-aws-cdk-lib/trees/aws-cdk-lib-2.33.0

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

na

Contributor guide

Open the contributing guide

Research direction

Compare the generated aws_iotwireless/__init__.py reference with the public CfnDeviceProfile documentation linked in the issue, focusing on the supports32_bit_fCnt and supports32_bit_f_cnt names. Reproduce the documented attribute assignment and trace where the generated name is defined. Done means the public name and generated Python API are consistent and the documented example no longer raises an exception.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.